MedicationAdministration

MedicationAdministration

medicationAdministrationGet

Get a MedicationAdministration resource based on the resource ID, or search by resource ID, patient ID, status, effective time, reason given, subject, reason not given, request, or patient identifier.


/MedicationAdministration/

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"//MedicationAdministration/?_id=&patient=&status=&effective-time=&reason-given=&subject=&reason-not-given=&request=&patient.identifer="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MedicationAdministrationApi;

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

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        Integer id = 56; // Integer | Resource identifier.
        String patient = patient_example; // String | Reference.
        String status = status_example; // String | Event status.
        date effectiveTime = ; // date | Time the administration occurred.
        String reasonGiven = reasonGiven_example; // String | Reason for the administration.
        String subject = subject_example; // String | Patient ID.
        String reasonNotGiven = reasonNotGiven_example; // String | Reason the administration was not given or refused.
        String request = request_example; // String | MedicationRequest ID.
        String patient.identifer = patient.identifer_example; // String | Patient ID.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationGet(id, patient, status, effectiveTime, reasonGiven, subject, reasonNotGiven, request, patient.identifer);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MedicationAdministrationApi;

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        Integer id = 56; // Integer | Resource identifier.
        String patient = patient_example; // String | Reference.
        String status = status_example; // String | Event status.
        date effectiveTime = ; // date | Time the administration occurred.
        String reasonGiven = reasonGiven_example; // String | Reason for the administration.
        String subject = subject_example; // String | Patient ID.
        String reasonNotGiven = reasonNotGiven_example; // String | Reason the administration was not given or refused.
        String request = request_example; // String | MedicationRequest ID.
        String patient.identifer = patient.identifer_example; // String | Patient ID.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationGet(id, patient, status, effectiveTime, reasonGiven, subject, reasonNotGiven, request, patient.identifer);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationGet");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // Resource identifier. (optional)
String *patient = patient_example; // Reference. (optional)
String *status = status_example; // Event status. (optional)
date *effectiveTime = ; // Time the administration occurred. (optional)
String *reasonGiven = reasonGiven_example; // Reason for the administration. (optional)
String *subject = subject_example; // Patient ID. (optional)
String *reasonNotGiven = reasonNotGiven_example; // Reason the administration was not given or refused. (optional)
String *request = request_example; // MedicationRequest ID. (optional)
String *patient.identifer = patient.identifer_example; // Patient ID. (optional)

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

[apiInstance medicationAdministrationGetWith:id
    patient:patient
    status:status
    effectiveTime:effectiveTime
    reasonGiven:reasonGiven
    subject:subject
    reasonNotGiven:reasonNotGiven
    request:request
    patient.identifer:patient.identifer
              completionHandler: ^(MedicationAdministration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MedicationAdministration = require('medication_administration');

var api = new MedicationAdministration.MedicationAdministrationApi()
var opts = { 
  'id': 56, // {{Integer}} Resource identifier.
  'patient': patient_example, // {{String}} Reference.
  'status': status_example, // {{String}} Event status.
  'effectiveTime': , // {{date}} Time the administration occurred.
  'reasonGiven': reasonGiven_example, // {{String}} Reason for the administration.
  'subject': subject_example, // {{String}} Patient ID.
  'reasonNotGiven': reasonNotGiven_example, // {{String}} Reason the administration was not given or refused.
  'request': request_example, // {{String}} MedicationRequest ID.
  'patient.identifer': patient.identifer_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.medicationAdministrationGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new MedicationAdministrationApi();
            var id = 56;  // Integer | Resource identifier. (optional) 
            var patient = patient_example;  // String | Reference. (optional) 
            var status = status_example;  // String | Event status. (optional) 
            var effectiveTime = new date(); // date | Time the administration occurred. (optional) 
            var reasonGiven = reasonGiven_example;  // String | Reason for the administration. (optional) 
            var subject = subject_example;  // String | Patient ID. (optional) 
            var reasonNotGiven = reasonNotGiven_example;  // String | Reason the administration was not given or refused. (optional) 
            var request = request_example;  // String | MedicationRequest ID. (optional) 
            var patient.identifer = patient.identifer_example;  // String | Patient ID. (optional) 

            try
            {
                MedicationAdministration result = apiInstance.medicationAdministrationGet(id, patient, status, effectiveTime, reasonGiven, subject, reasonNotGiven, request, patient.identifer);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MedicationAdministrationApi.medicationAdministrationGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiMedicationAdministrationApi();
$id = 56; // Integer | Resource identifier.
$patient = patient_example; // String | Reference.
$status = status_example; // String | Event status.
$effectiveTime = ; // date | Time the administration occurred.
$reasonGiven = reasonGiven_example; // String | Reason for the administration.
$subject = subject_example; // String | Patient ID.
$reasonNotGiven = reasonNotGiven_example; // String | Reason the administration was not given or refused.
$request = request_example; // String | MedicationRequest ID.
$patient.identifer = patient.identifer_example; // String | Patient ID.

try {
    $result = $api_instance->medicationAdministrationGet($id, $patient, $status, $effectiveTime, $reasonGiven, $subject, $reasonNotGiven, $request, $patient.identifer);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MedicationAdministrationApi->medicationAdministrationGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MedicationAdministrationApi;

my $api_instance = WWW::SwaggerClient::MedicationAdministrationApi->new();
my $id = 56; # Integer | Resource identifier.
my $patient = patient_example; # String | Reference.
my $status = status_example; # String | Event status.
my $effectiveTime = ; # date | Time the administration occurred.
my $reasonGiven = reasonGiven_example; # String | Reason for the administration.
my $subject = subject_example; # String | Patient ID.
my $reasonNotGiven = reasonNotGiven_example; # String | Reason the administration was not given or refused.
my $request = request_example; # String | MedicationRequest ID.
my $patient.identifer = patient.identifer_example; # String | Patient ID.

eval { 
    my $result = $api_instance->medicationAdministrationGet(id => $id, patient => $patient, status => $status, effectiveTime => $effectiveTime, reasonGiven => $reasonGiven, subject => $subject, reasonNotGiven => $reasonNotGiven, request => $request, patient.identifer => $patient.identifer);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MedicationAdministrationApi->medicationAdministrationGet: $@\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.MedicationAdministrationApi()
id = 56 # Integer | Resource identifier. (optional)
patient = patient_example # String | Reference. (optional)
status = status_example # String | Event status. (optional)
effectiveTime =  # date | Time the administration occurred. (optional)
reasonGiven = reasonGiven_example # String | Reason for the administration. (optional)
subject = subject_example # String | Patient ID. (optional)
reasonNotGiven = reasonNotGiven_example # String | Reason the administration was not given or refused. (optional)
request = request_example # String | MedicationRequest ID. (optional)
patient.identifer = patient.identifer_example # String | Patient ID. (optional)

try: 
    api_response = api_instance.medication_administration_get(id=id, patient=patient, status=status, effectiveTime=effectiveTime, reasonGiven=reasonGiven, subject=subject, reasonNotGiven=reasonNotGiven, request=request, patient.identifer=patient.identifer)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MedicationAdministrationApi->medicationAdministrationGet: %s\n" % e)

Parameters

Query parameters
Name Description
_id
Integer
Resource identifier.
patient
String
Reference.
status
String
Event status.
effective-time
date
Time the administration occurred.
reason-given
String
Reason for the administration.
subject
String
Patient ID.
reason-not-given
String
Reason the administration was not given or refused.
request
String
MedicationRequest ID.
patient.identifer
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


medicationAdministrationPatientEffectiveTimeGet

Get a MedicationAdministration resource based on the combination of patient and effective time.


/MedicationAdministration/[patient]&[effective-time]

Usage and SDK Samples

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

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

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String patient = patient_example; // String | Reference.
        date effectiveTime = ; // date | Time the administration occurred.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationPatientEffectiveTimeGet(patient, effectiveTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationPatientEffectiveTimeGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MedicationAdministrationApi;

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String patient = patient_example; // String | Reference.
        date effectiveTime = ; // date | Time the administration occurred.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationPatientEffectiveTimeGet(patient, effectiveTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationPatientEffectiveTimeGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Reference. (optional)
date *effectiveTime = ; // Time the administration occurred. (optional)

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

[apiInstance medicationAdministrationPatientEffectiveTimeGetWith:patient
    effectiveTime:effectiveTime
              completionHandler: ^(MedicationAdministration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MedicationAdministration = require('medication_administration');

var api = new MedicationAdministration.MedicationAdministrationApi()
var opts = { 
  'patient': patient_example, // {{String}} Reference.
  'effectiveTime':  // {{date}} Time the administration occurred.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.medicationAdministrationPatientEffectiveTimeGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new MedicationAdministrationApi();
            var patient = patient_example;  // String | Reference. (optional) 
            var effectiveTime = new date(); // date | Time the administration occurred. (optional) 

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

$api_instance = new Swagger\Client\ApiMedicationAdministrationApi();
$patient = patient_example; // String | Reference.
$effectiveTime = ; // date | Time the administration occurred.

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

my $api_instance = WWW::SwaggerClient::MedicationAdministrationApi->new();
my $patient = patient_example; # String | Reference.
my $effectiveTime = ; # date | Time the administration occurred.

eval { 
    my $result = $api_instance->medicationAdministrationPatientEffectiveTimeGet(patient => $patient, effectiveTime => $effectiveTime);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MedicationAdministrationApi->medicationAdministrationPatientEffectiveTimeGet: $@\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.MedicationAdministrationApi()
patient = patient_example # String | Reference. (optional)
effectiveTime =  # date | Time the administration occurred. (optional)

try: 
    api_response = api_instance.medication_administration_patient_effective_time_get(patient=patient, effectiveTime=effectiveTime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MedicationAdministrationApi->medicationAdministrationPatientEffectiveTimeGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Reference.
effective-time
date
Time the administration occurred.

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


medicationAdministrationPatientIntentAuthoredonGet

Get a MedicationAdministration resource based on the combination of patient, status, and intent.


/MedicationAdministration/[patient]&[intent]&[authoredon]

Usage and SDK Samples

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

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

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String patient = patient_example; // String | Reference.
        String intent = intent_example; // String | Medication instance order.
        String authoredon = authoredon_example; // String | The date (and perhaps time) when the prescription was initially written or authored on.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationPatientIntentAuthoredonGet(patient, intent, authoredon);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationPatientIntentAuthoredonGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MedicationAdministrationApi;

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String patient = patient_example; // String | Reference.
        String intent = intent_example; // String | Medication instance order.
        String authoredon = authoredon_example; // String | The date (and perhaps time) when the prescription was initially written or authored on.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationPatientIntentAuthoredonGet(patient, intent, authoredon);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationPatientIntentAuthoredonGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Reference. (optional)
String *intent = intent_example; // Medication instance order. (optional)
String *authoredon = authoredon_example; // The date (and perhaps time) when the prescription was initially written or authored on. (optional)

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

[apiInstance medicationAdministrationPatientIntentAuthoredonGetWith:patient
    intent:intent
    authoredon:authoredon
              completionHandler: ^(MedicationAdministration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MedicationAdministration = require('medication_administration');

var api = new MedicationAdministration.MedicationAdministrationApi()
var opts = { 
  'patient': patient_example, // {{String}} Reference.
  'intent': intent_example, // {{String}} Medication instance order.
  'authoredon': authoredon_example // {{String}} The date (and perhaps time) when the prescription was initially written or authored on.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.medicationAdministrationPatientIntentAuthoredonGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new MedicationAdministrationApi();
            var patient = patient_example;  // String | Reference. (optional) 
            var intent = intent_example;  // String | Medication instance order. (optional) 
            var authoredon = authoredon_example;  // String | The date (and perhaps time) when the prescription was initially written or authored on. (optional) 

            try
            {
                MedicationAdministration result = apiInstance.medicationAdministrationPatientIntentAuthoredonGet(patient, intent, authoredon);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MedicationAdministrationApi.medicationAdministrationPatientIntentAuthoredonGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiMedicationAdministrationApi();
$patient = patient_example; // String | Reference.
$intent = intent_example; // String | Medication instance order.
$authoredon = authoredon_example; // String | The date (and perhaps time) when the prescription was initially written or authored on.

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

my $api_instance = WWW::SwaggerClient::MedicationAdministrationApi->new();
my $patient = patient_example; # String | Reference.
my $intent = intent_example; # String | Medication instance order.
my $authoredon = authoredon_example; # String | The date (and perhaps time) when the prescription was initially written or authored on.

eval { 
    my $result = $api_instance->medicationAdministrationPatientIntentAuthoredonGet(patient => $patient, intent => $intent, authoredon => $authoredon);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MedicationAdministrationApi->medicationAdministrationPatientIntentAuthoredonGet: $@\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.MedicationAdministrationApi()
patient = patient_example # String | Reference. (optional)
intent = intent_example # String | Medication instance order. (optional)
authoredon = authoredon_example # String | The date (and perhaps time) when the prescription was initially written or authored on. (optional)

try: 
    api_response = api_instance.medication_administration_patient_intent_authoredon_get(patient=patient, intent=intent, authoredon=authoredon)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MedicationAdministrationApi->medicationAdministrationPatientIntentAuthoredonGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Reference.
intent
String
Medication instance order.
authoredon
String
The date (and perhaps time) when the prescription was initially written or authored on.

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


medicationAdministrationPatientIntentEncounterGet

Get a MedicationAdministration resource based on the combination of patient, intent, and encounter.


/MedicationAdministration/[patient]&[intent]&[encounter]

Usage and SDK Samples

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

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

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String patient = patient_example; // String | Reference.
        String intent = intent_example; // String | Medication instance order.
        String encounter = encounter_example; // String | Encounter ID.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationPatientIntentEncounterGet(patient, intent, encounter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationPatientIntentEncounterGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MedicationAdministrationApi;

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String patient = patient_example; // String | Reference.
        String intent = intent_example; // String | Medication instance order.
        String encounter = encounter_example; // String | Encounter ID.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationPatientIntentEncounterGet(patient, intent, encounter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationPatientIntentEncounterGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Reference. (optional)
String *intent = intent_example; // Medication instance order. (optional)
String *encounter = encounter_example; // Encounter ID. (optional)

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

[apiInstance medicationAdministrationPatientIntentEncounterGetWith:patient
    intent:intent
    encounter:encounter
              completionHandler: ^(MedicationAdministration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MedicationAdministration = require('medication_administration');

var api = new MedicationAdministration.MedicationAdministrationApi()
var opts = { 
  'patient': patient_example, // {{String}} Reference.
  'intent': intent_example, // {{String}} Medication instance order.
  'encounter': encounter_example // {{String}} Encounter ID.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.medicationAdministrationPatientIntentEncounterGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new MedicationAdministrationApi();
            var patient = patient_example;  // String | Reference. (optional) 
            var intent = intent_example;  // String | Medication instance order. (optional) 
            var encounter = encounter_example;  // String | Encounter ID. (optional) 

            try
            {
                MedicationAdministration result = apiInstance.medicationAdministrationPatientIntentEncounterGet(patient, intent, encounter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MedicationAdministrationApi.medicationAdministrationPatientIntentEncounterGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiMedicationAdministrationApi();
$patient = patient_example; // String | Reference.
$intent = intent_example; // String | Medication instance order.
$encounter = encounter_example; // String | Encounter ID.

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

my $api_instance = WWW::SwaggerClient::MedicationAdministrationApi->new();
my $patient = patient_example; # String | Reference.
my $intent = intent_example; # String | Medication instance order.
my $encounter = encounter_example; # String | Encounter ID.

eval { 
    my $result = $api_instance->medicationAdministrationPatientIntentEncounterGet(patient => $patient, intent => $intent, encounter => $encounter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MedicationAdministrationApi->medicationAdministrationPatientIntentEncounterGet: $@\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.MedicationAdministrationApi()
patient = patient_example # String | Reference. (optional)
intent = intent_example # String | Medication instance order. (optional)
encounter = encounter_example # String | Encounter ID. (optional)

try: 
    api_response = api_instance.medication_administration_patient_intent_encounter_get(patient=patient, intent=intent, encounter=encounter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MedicationAdministrationApi->medicationAdministrationPatientIntentEncounterGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Reference.
intent
String
Medication instance order.
encounter
String
Encounter 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


medicationAdministrationPatientIntentStatusGet

Get a MedicationAdministration resource based on the combination of patient, status, and intent.


/MedicationAdministration/[patient]&[intent]&[status]

Usage and SDK Samples

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

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

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String patient = patient_example; // String | Reference.
        String status = status_example; // String | Event status.
        String intent = intent_example; // String | Medication instance order.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationPatientIntentStatusGet(patient, status, intent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationPatientIntentStatusGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MedicationAdministrationApi;

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String patient = patient_example; // String | Reference.
        String status = status_example; // String | Event status.
        String intent = intent_example; // String | Medication instance order.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationPatientIntentStatusGet(patient, status, intent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationPatientIntentStatusGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Reference. (optional)
String *status = status_example; // Event status. (optional)
String *intent = intent_example; // Medication instance order. (optional)

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

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

var api = new MedicationAdministration.MedicationAdministrationApi()
var opts = { 
  'patient': patient_example, // {{String}} Reference.
  'status': status_example, // {{String}} Event status.
  'intent': intent_example // {{String}} Medication instance order.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.medicationAdministrationPatientIntentStatusGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new MedicationAdministrationApi();
            var patient = patient_example;  // String | Reference. (optional) 
            var status = status_example;  // String | Event status. (optional) 
            var intent = intent_example;  // String | Medication instance order. (optional) 

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

$api_instance = new Swagger\Client\ApiMedicationAdministrationApi();
$patient = patient_example; // String | Reference.
$status = status_example; // String | Event status.
$intent = intent_example; // String | Medication instance order.

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

my $api_instance = WWW::SwaggerClient::MedicationAdministrationApi->new();
my $patient = patient_example; # String | Reference.
my $status = status_example; # String | Event status.
my $intent = intent_example; # String | Medication instance order.

eval { 
    my $result = $api_instance->medicationAdministrationPatientIntentStatusGet(patient => $patient, status => $status, intent => $intent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MedicationAdministrationApi->medicationAdministrationPatientIntentStatusGet: $@\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.MedicationAdministrationApi()
patient = patient_example # String | Reference. (optional)
status = status_example # String | Event status. (optional)
intent = intent_example # String | Medication instance order. (optional)

try: 
    api_response = api_instance.medication_administration_patient_intent_status_get(patient=patient, status=status, intent=intent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MedicationAdministrationApi->medicationAdministrationPatientIntentStatusGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Reference.
status
String
Event status.
intent
String
Medication instance order.

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


medicationAdministrationPatientReasonGivenGet

Get a MedicationAdministration resource based on the combination of patient and reason for the administration.


/MedicationAdministration/[patient]&[reason-given]

Usage and SDK Samples

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

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

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String patient = patient_example; // String | Reference.
        String reasonGiven = reasonGiven_example; // String | Reason for the administration.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationPatientReasonGivenGet(patient, reasonGiven);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationPatientReasonGivenGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MedicationAdministrationApi;

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String patient = patient_example; // String | Reference.
        String reasonGiven = reasonGiven_example; // String | Reason for the administration.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationPatientReasonGivenGet(patient, reasonGiven);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationPatientReasonGivenGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Reference. (optional)
String *reasonGiven = reasonGiven_example; // Reason for the administration. (optional)

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

[apiInstance medicationAdministrationPatientReasonGivenGetWith:patient
    reasonGiven:reasonGiven
              completionHandler: ^(MedicationAdministration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MedicationAdministration = require('medication_administration');

var api = new MedicationAdministration.MedicationAdministrationApi()
var opts = { 
  'patient': patient_example, // {{String}} Reference.
  'reasonGiven': reasonGiven_example // {{String}} Reason for the administration.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.medicationAdministrationPatientReasonGivenGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new MedicationAdministrationApi();
            var patient = patient_example;  // String | Reference. (optional) 
            var reasonGiven = reasonGiven_example;  // String | Reason for the administration. (optional) 

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

$api_instance = new Swagger\Client\ApiMedicationAdministrationApi();
$patient = patient_example; // String | Reference.
$reasonGiven = reasonGiven_example; // String | Reason for the administration.

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

my $api_instance = WWW::SwaggerClient::MedicationAdministrationApi->new();
my $patient = patient_example; # String | Reference.
my $reasonGiven = reasonGiven_example; # String | Reason for the administration.

eval { 
    my $result = $api_instance->medicationAdministrationPatientReasonGivenGet(patient => $patient, reasonGiven => $reasonGiven);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MedicationAdministrationApi->medicationAdministrationPatientReasonGivenGet: $@\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.MedicationAdministrationApi()
patient = patient_example # String | Reference. (optional)
reasonGiven = reasonGiven_example # String | Reason for the administration. (optional)

try: 
    api_response = api_instance.medication_administration_patient_reason_given_get(patient=patient, reasonGiven=reasonGiven)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MedicationAdministrationApi->medicationAdministrationPatientReasonGivenGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Reference.
reason-given
String
Reason for the administration.

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


medicationAdministrationPatientReasonNotGivenGet

Get a MedicationAdministration resource based on the combination of patient and reason for not giving the administration.


/MedicationAdministration/[patient]&[reason-not-given]

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"//MedicationAdministration/[patient]&[reason-not-given]?patient=&reason-not-given="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MedicationAdministrationApi;

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

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String patient = patient_example; // String | Reference.
        String reasonNotGiven = reasonNotGiven_example; // String | Reason for not giving the administration.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationPatientReasonNotGivenGet(patient, reasonNotGiven);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationPatientReasonNotGivenGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MedicationAdministrationApi;

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String patient = patient_example; // String | Reference.
        String reasonNotGiven = reasonNotGiven_example; // String | Reason for not giving the administration.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationPatientReasonNotGivenGet(patient, reasonNotGiven);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationPatientReasonNotGivenGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Reference. (optional)
String *reasonNotGiven = reasonNotGiven_example; // Reason for not giving the administration. (optional)

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

[apiInstance medicationAdministrationPatientReasonNotGivenGetWith:patient
    reasonNotGiven:reasonNotGiven
              completionHandler: ^(MedicationAdministration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MedicationAdministration = require('medication_administration');

var api = new MedicationAdministration.MedicationAdministrationApi()
var opts = { 
  'patient': patient_example, // {{String}} Reference.
  'reasonNotGiven': reasonNotGiven_example // {{String}} Reason for not giving the administration.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.medicationAdministrationPatientReasonNotGivenGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new MedicationAdministrationApi();
            var patient = patient_example;  // String | Reference. (optional) 
            var reasonNotGiven = reasonNotGiven_example;  // String | Reason for not giving the administration. (optional) 

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

$api_instance = new Swagger\Client\ApiMedicationAdministrationApi();
$patient = patient_example; // String | Reference.
$reasonNotGiven = reasonNotGiven_example; // String | Reason for not giving the administration.

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

my $api_instance = WWW::SwaggerClient::MedicationAdministrationApi->new();
my $patient = patient_example; # String | Reference.
my $reasonNotGiven = reasonNotGiven_example; # String | Reason for not giving the administration.

eval { 
    my $result = $api_instance->medicationAdministrationPatientReasonNotGivenGet(patient => $patient, reasonNotGiven => $reasonNotGiven);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MedicationAdministrationApi->medicationAdministrationPatientReasonNotGivenGet: $@\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.MedicationAdministrationApi()
patient = patient_example # String | Reference. (optional)
reasonNotGiven = reasonNotGiven_example # String | Reason for not giving the administration. (optional)

try: 
    api_response = api_instance.medication_administration_patient_reason_not_given_get(patient=patient, reasonNotGiven=reasonNotGiven)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MedicationAdministrationApi->medicationAdministrationPatientReasonNotGivenGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Reference.
reason-not-given
String
Reason for not giving the administration.

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


medicationAdministrationPatientRequestGet

Get a MedicationAdministration resource based on the combination of patient and request ID.


/MedicationAdministration/[patient]&[request]

Usage and SDK Samples

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

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

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String patient = patient_example; // String | Reference.
        String request = request_example; // String | MedicationRequest ID.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationPatientRequestGet(patient, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationPatientRequestGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MedicationAdministrationApi;

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String patient = patient_example; // String | Reference.
        String request = request_example; // String | MedicationRequest ID.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationPatientRequestGet(patient, request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationPatientRequestGet");
            e.printStackTrace();
        }
    }
}
String *patient = patient_example; // Reference. (optional)
String *request = request_example; // MedicationRequest ID. (optional)

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

[apiInstance medicationAdministrationPatientRequestGetWith:patient
    request:request
              completionHandler: ^(MedicationAdministration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MedicationAdministration = require('medication_administration');

var api = new MedicationAdministration.MedicationAdministrationApi()
var opts = { 
  'patient': patient_example, // {{String}} Reference.
  'request': request_example // {{String}} MedicationRequest ID.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.medicationAdministrationPatientRequestGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new MedicationAdministrationApi();
            var patient = patient_example;  // String | Reference. (optional) 
            var request = request_example;  // String | MedicationRequest ID. (optional) 

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

$api_instance = new Swagger\Client\ApiMedicationAdministrationApi();
$patient = patient_example; // String | Reference.
$request = request_example; // String | MedicationRequest ID.

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

my $api_instance = WWW::SwaggerClient::MedicationAdministrationApi->new();
my $patient = patient_example; # String | Reference.
my $request = request_example; # String | MedicationRequest ID.

eval { 
    my $result = $api_instance->medicationAdministrationPatientRequestGet(patient => $patient, request => $request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MedicationAdministrationApi->medicationAdministrationPatientRequestGet: $@\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.MedicationAdministrationApi()
patient = patient_example # String | Reference. (optional)
request = request_example # String | MedicationRequest ID. (optional)

try: 
    api_response = api_instance.medication_administration_patient_request_get(patient=patient, request=request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MedicationAdministrationApi->medicationAdministrationPatientRequestGet: %s\n" % e)

Parameters

Query parameters
Name Description
patient
String
Reference.
request
String
MedicationRequest 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


medicationAdministrationPatientStatusGet

Get a MedicationAdministration resource based on the combination of patient and administration status.


/MedicationAdministration/[patient]&[status]

Usage and SDK Samples

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

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

public class MedicationAdministrationApiExample {

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

public class MedicationAdministrationApiExample {

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

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

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

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

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

            var apiInstance = new MedicationAdministrationApi();
            var patient = patient_example;  // String | Reference. (optional) 
            var status = status_example;  // String | Event status. (optional) 

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

$api_instance = new Swagger\Client\ApiMedicationAdministrationApi();
$patient = patient_example; // String | Reference.
$status = status_example; // String | Event status.

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

my $api_instance = WWW::SwaggerClient::MedicationAdministrationApi->new();
my $patient = patient_example; # String | Reference.
my $status = status_example; # String | Event status.

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

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

Parameters

Query parameters
Name Description
patient
String
Reference.
status
String
Event 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


medicationAdministrationStatusIntentGet

Get a MedicationAdministration resource based on the combination of status and intent.


/MedicationAdministration/[status]&[intent]

Usage and SDK Samples

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

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

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String status = status_example; // String | Event status.
        String intent = intent_example; // String | Medication instance order.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationStatusIntentGet(status, intent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationStatusIntentGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MedicationAdministrationApi;

public class MedicationAdministrationApiExample {

    public static void main(String[] args) {
        MedicationAdministrationApi apiInstance = new MedicationAdministrationApi();
        String status = status_example; // String | Event status.
        String intent = intent_example; // String | Medication instance order.
        try {
            MedicationAdministration result = apiInstance.medicationAdministrationStatusIntentGet(status, intent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MedicationAdministrationApi#medicationAdministrationStatusIntentGet");
            e.printStackTrace();
        }
    }
}
String *status = status_example; // Event status. (optional)
String *intent = intent_example; // Medication instance order. (optional)

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

[apiInstance medicationAdministrationStatusIntentGetWith:status
    intent:intent
              completionHandler: ^(MedicationAdministration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MedicationAdministration = require('medication_administration');

var api = new MedicationAdministration.MedicationAdministrationApi()
var opts = { 
  'status': status_example, // {{String}} Event status.
  'intent': intent_example // {{String}} Medication instance order.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.medicationAdministrationStatusIntentGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new MedicationAdministrationApi();
            var status = status_example;  // String | Event status. (optional) 
            var intent = intent_example;  // String | Medication instance order. (optional) 

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

$api_instance = new Swagger\Client\ApiMedicationAdministrationApi();
$status = status_example; // String | Event status.
$intent = intent_example; // String | Medication instance order.

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

my $api_instance = WWW::SwaggerClient::MedicationAdministrationApi->new();
my $status = status_example; # String | Event status.
my $intent = intent_example; # String | Medication instance order.

eval { 
    my $result = $api_instance->medicationAdministrationStatusIntentGet(status => $status, intent => $intent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MedicationAdministrationApi->medicationAdministrationStatusIntentGet: $@\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.MedicationAdministrationApi()
status = status_example # String | Event status. (optional)
intent = intent_example # String | Medication instance order. (optional)

try: 
    api_response = api_instance.medication_administration_status_intent_get(status=status, intent=intent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MedicationAdministrationApi->medicationAdministrationStatusIntentGet: %s\n" % e)

Parameters

Query parameters
Name Description
status
String
Event status.
intent
String
Medication instance order.

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