Module health.clients.fhir.athenahealth

ballerinax/health.clients.fhir.athenahealth Ballerina library

1.0.0

FHIR Client Connector

FHIR client connector that can be used to connect to a FHIR server and perform common interactions and operations.

Capability Statement

https://api.preview.platform.athenahealth.com/fhir/r4/metadata

Supported FHIR Resource Types

The table below lists supported resource types, interactions and operations. Interactions are shown as inline code and separated by line breaks for readability.

Resource Type	Interactions	Operations
AllergyIntolerance	`read` `search-type`	-
Appointment	`read` `search-type`	-
Binary	`read`	-
CarePlan	`read` `search-type`	-
CareTeam	`read` `search-type`	-
Condition	`read` `search-type`	-
Coverage	`read` `search-type`	-
Device	`read` `search-type`	-
DiagnosticReport	`read` `search-type`	-
DocumentReference	`read` `search-type`	-
Encounter	`read` `search-type`	-
Goal	`read` `search-type`	-
Immunization	`read` `search-type`	-
Location	`read` `search-type`	-
Medication	`read` `search-type`	-
MedicationRequest	`read` `search-type`	-
Observation	`read` `search-type`	-
Organization	`read` `search-type`	-
Patient	`read` `search-type`	`health-cards-issue`
Practitioner	`read` `search-type`	-
Procedure	`read` `search-type`	-
Provenance	`read` `search-type`	-
ServiceRequest	`read` `search-type`	-
Group		`export`
QuestionnaireResponse	`create` `search-type` `read`	`latest-response-by-questionnaire`
MeasureReport		`submit-care-gaps`
Media	`read`	-
MedicationDispense	`search-type` `read`	-
Specimen	`search-type` `read`	-
RelatedPerson	`search-type` `read`	-

Notes:

— indicates no special operations supported for that resource in this connector.
Use the server's CapabilityStatement to verify support for additional interactions or operations on a given server instance.

Functions

The connector represents the interactions and operations as functions. Each function corresponds to a specific FHIR interaction or operation.

Interaction/Operation	Function
Read	`get{ResourceType}ById`
Version Read	`get{ResourceType}ByVersion`
Update	`update{ResourceType}`
Patch	`patch{ResourceType}`
Delete	`delete{ResourceType}`
History Type	`get{ResourceType}History`
History Instance	`get{ResourceType}InstanceHistory`
Create	`create{ResourceType}`
Search Type	`search{ResourceType}`
$Operation	`{Operation}{ResourceType}Operation`

Replace {ResourceType} with the actual resource type (e.g., Patient, Observation) and {Operation} with the specific operation name (e.g., everything, validate).

Sample Usage

import ballerinax/health.clients.fhir as fhirClient;
import /athena.fhir.connector;
import ballerina/io;

public function main() returns error? {
    // Initialize the Athena connector client
    fhirClient:FHIRConnectorConfig athenaConfig = {
        baseURL: base,
        mimeType: fhirClient:FHIR_JSON,
        authConfig: {
            tokenUrl: tokenUrl,
            clientId: clientId,
            clientSecret: clientSecret,
            scopes: scopes
        }
    };
    connector:FHIRClientConnector athenaFhirclientconnector = check new (athenaConfig);
    
    // Example 1: Read a patient by ID
    fhir:FHIRResponse fhirFhirresponse = check athenaFhirclientconnector->getPatientById("patient-id-123");
    io:println("Patient Read Response: ", fhirFhirresponse.'resource);

}

Clients

health.clients.fhir.athenahealth: FHIRClientConnector

This connector allows you to connect and interact with any FHIR server

getAllergyIntoleranceById

Remote Function

function getAllergyIntoleranceById(string id) returns FHIRResponse|FHIRError

Auto-generated operations

Parameters

id string - The logical ID of the AllergyIntolerance resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchAllergyIntolerance

Remote Function

function searchAllergyIntolerance(string? patient, string? _count, string? cursor, string? _revinclude, string? _include, string? ah_chart_sharing_group, string[]? _lastUpdated, string? code, string? ah_practice, string? _security) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - AllergyIntolerance

_count string? (default ()) - Search parameter for _count (number) - The number of AllergyIntolerance resources to return per page for paged search results

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return

_revinclude string? (default ()) - Search parameter for _revinclude (special) - AllergyIntolerance

_include string? (default ()) - Search parameter for _include (special) - AllergyIntolerance

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by Athena Chart Sharing Group for resources containing the 'Athena Chart Sharing Group' Extension

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated date associated with the AllergyIntolerance (format: YYYY-MM-DD)

code string? (default ()) - Search parameter for code (token) - Code to which this AllergyIntolerance is associated

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getAppointmentById

Remote Function

function getAppointmentById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Appointment resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchAppointment

Remote Function

function searchAppointment(string? _id, string? _query, string? base_appointment_id, string? group_appointment_id, string? ah_practice, string? _security) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - Appointment

_query string? (default ()) - Search parameter for _query (string) - Custom named query

base_appointment_id string? (default ()) - Search parameter for base-appointment-id (reference) - Search by Athena Appointment ID for resources containing the 'Athena Group Appointment' Extension

group_appointment_id string? (default ()) - Search parameter for group-appointment-id (reference) - Search by Athena Group Appointment ID for resources containing the same 'Athena Group Appointment' Extension

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getBinaryById

Remote Function

function getBinaryById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Binary resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getCarePlanById

Remote Function

function getCarePlanById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the CarePlan resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchCarePlan

Remote Function

function searchCarePlan(string? patient, string? category, string[]? _lastUpdated, string? _count, string? _id, string? _revinclude, string? _include, string? cursor, string? ah_practice, string? ah_brand, string? ah_chart_sharing_group, string? ah_department, string? ah_provider_group, string? _security) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - CarePlan

category string? (default ()) - Search parameter for category (token) - CarePlan

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated date associated with the CarePlan (format: YYYY-MM-DD)

_count string? (default ()) - Search parameter for _count (number) - The number of CarePlan resources to return per page for paged search results

_id string? (default ()) - Search parameter for _id (token) - CarePlan

_revinclude string? (default ()) - Search parameter for _revinclude (special) - CarePlan

_include string? (default ()) - Search parameter for _include (special) - CarePlan

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

ah_brand string? (default ()) - Search parameter for ah-brand (reference) - Search by Athena Brand for resources containing the 'Athena Brand' Extension

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by Athena Chart Sharing Group for resources containing the 'Athena Chart Sharing Group' Extension

ah_department string? (default ()) - Search parameter for ah-department (reference) - Search by Athena Department for resources containing the 'Athena Department' Extension

ah_provider_group string? (default ()) - Search parameter for ah-provider-group (reference) - Search by Athena Provider Group for resources containing the 'Athena Provider Group' Extension

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getCareTeamById

Remote Function

function getCareTeamById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the CareTeam resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchCareTeam

Remote Function

function searchCareTeam(string? patient, string? status, string[]? _lastUpdated, string? _count, string? _id, string? _revinclude, string? _include, string? cursor, string? ah_brand, string? ah_chart_sharing_group, string? ah_practice, string? ah_department, string? ah_provider_group, string? _security) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - CareTeam

status string? (default ()) - Search parameter for status (token) - CareTeam

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated date associated with the CareTeam (format: YYYY-MM-DD)

_count string? (default ()) - Search parameter for _count (number) - The number of CareTeam resources to return per page for paged search results

_id string? (default ()) - Search parameter for _id (token) - CareTeam

_revinclude string? (default ()) - Search parameter for _revinclude (special) - CareTeam

_include string? (default ()) - Search parameter for _include (special) - CareTeam

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return

ah_brand string? (default ()) - Search parameter for ah-brand (reference) - Search by Athena Brand for resources containing the 'Athena Brand' Extension

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by Athena Chart Sharing Group for resources containing the 'Athena Chart Sharing Group' Extension

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

ah_department string? (default ()) - Search parameter for ah-department (reference) - Search by Athena Department for resources containing the 'Athena Department' Extension

ah_provider_group string? (default ()) - Search parameter for ah-provider-group (reference) - Search by Athena Provider Group for resources containing the 'Athena Provider Group' Extension

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getConditionById

Remote Function

function getConditionById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Condition resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchCondition

Remote Function

function searchCondition(string? _id, string? patient, string? encounter, string? _revinclude, string? _include, string? ah_chart_sharing_group, string? ah_practice, string? _count, string? cursor, string[]? _lastUpdated, string? code, string? category, string? ah_redact_inline_security, string? _security) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - Resource id (not a full URL)

patient string? (default ()) - Search parameter for patient (reference) - Who has the condition?

encounter string? (default ()) - Search parameter for encounter (reference) - Encounter to which this Condition is associated

_revinclude string? (default ()) - Search parameter for _revinclude (special) - Other resources to include in the search results when they refer to search matches

_include string? (default ()) - Search parameter for _include (special) - Other resources to include in the search results that search matches point to

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by Athena Chart Sharing Group for resources containing the 'Athena Chart Sharing Group' Extension

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

_count string? (default ()) - Search parameter for _count (number) - The number of Condition resources to return per page for paged search results

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated date associated with the condition (format: YYYY-MM-DD)

code string? (default ()) - Search parameter for code (token) - Code to which this Condition is associated

category string? (default ()) - Search parameter for category (token) - Category of the condition in the format [parameter]=[system]|[code](e

ah_redact_inline_security string? (default ()) - Search parameter for ah-redact-inline-security (token) - Security label for redacting inline data separately from top-level resources

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getCoverageById

Remote Function

function getCoverageById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Coverage resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchCoverage

Remote Function

function searchCoverage(string? _count, string? cursor, string? patient, string? _revinclude, string[]? _lastUpdated, string? ah_provider_group, string? ah_practice, string? _security) returns FHIRResponse|FHIRError

Parameters

_count string? (default ()) - Search parameter for _count (number) - The number of Coverage resources to return per page for paged search results

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return

patient string? (default ()) - Search parameter for patient (reference) - Coverage

_revinclude string? (default ()) - Search parameter for _revinclude (special) - Coverage

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated date of the coverage (_lastUpdated may only be used in conjunction with other supported search parameter combinations)

ah_provider_group string? (default ()) - Search parameter for ah-provider-group (reference) - Search by Athena Provider Group for resources containing the 'Athena Provider Group' Extension

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getDeviceById

Remote Function

function getDeviceById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Device resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchDevice

Remote Function

function searchDevice(string? patient, string? _count, string? _include, string? cursor, string? _revinclude, string? _id, string? ah_chart_sharing_group, string? ah_practice, string[]? _lastUpdated, string? _security) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - Device

_count string? (default ()) - Search parameter for _count (number) - The number of Device resources to return per page for paged search results

_include string? (default ()) - Search parameter for _include (special) - Device

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return

_revinclude string? (default ()) - Search parameter for _revinclude (special) - Device

_id string? (default ()) - Search parameter for _id (token) - Device

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by Athena Chart Sharing Group for resources containing the 'Athena Chart Sharing Group' Extension

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated parameter consists of a comparator (eq, gt, lt, ge and le) and a date (format: YYYY-MM-DD)

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getDiagnosticReportById

Remote Function

function getDiagnosticReportById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the DiagnosticReport resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchDiagnosticReport

Remote Function

function searchDiagnosticReport(string? _id, string? _query, string? encounter, string? patient, string? _include, string? _revinclude, string? category, string? code, string? date, string? _count, string? cursor, string? result, string? performer, string? ah_chart_sharing_group, string[]? _lastUpdated, string? ah_practice, string? _security) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - DiagnosticReport

_query string? (default ()) - Search parameter for _query (string) - Custom named query

encounter string? (default ()) - Search parameter for encounter (reference) - Resource reference to FHIR Encounter resource

patient string? (default ()) - Search parameter for patient (reference) - DiagnosticReport

_include string? (default ()) - Search parameter for _include (special) - DiagnosticReport

_revinclude string? (default ()) - Search parameter for _revinclude (special) - DiagnosticReport

category string? (default ()) - Search parameter for category (token) - DiagnosticReport

code string? (default ()) - Search parameter for code (token) - DiagnosticReport

date string? (default ()) - Search parameter for date (date) - DiagnosticReport

_count string? (default ()) - Search parameter for _count (number) - The number of DiagnosticReport resources to return per page for paged search results

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return

result string? (default ()) - Search parameter for result (reference) - DiagnostReport

performer string? (default ()) - Search parameter for performer (reference) - DiagnosticReport

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by athena Chart Sharing Group for resources containing the 'athena Chart Sharing Group' Extension

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - DiagnosticReport

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getDocumentReferenceById

Remote Function

function getDocumentReferenceById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the DocumentReference resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchDocumentReference

Remote Function

function searchDocumentReference(string? _id, string? patient, string? _include, string? _query, string? _revinclude, string? _sort, string? category, string? 'type, string? date, string? _count, string? cursor, string? encounter, string? author, string? custodian, string[]? _lastUpdated, string? ah_chart_sharing_group, string? ah_published_date_time_to_portal, string? ah_practice, string? _security) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - DocumentReference

patient string? (default ()) - Search parameter for patient (reference) - DocumentReference

_include string? (default ()) - Search parameter for _include (special) - DocumentReference

_query string? (default ()) - Search parameter for _query (string) - Custom named query

_revinclude string? (default ()) - Search parameter for _revinclude (special) - DocumentReference

_sort string? (default ()) - Search parameter for _sort (special) - DocumentReference

category string? (default ()) - Search parameter for category (token) - DocumentReference

'type string? (default ()) - Search parameter for type (token) - DocumentReference

date string? (default ()) - Search parameter for date (date) - DocumentReference

_count string? (default ()) - Search parameter for _count (number) - The number of DocumentReference resources to return per page for paged search results

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return

encounter string? (default ()) - Search parameter for encounter (reference) - DocumentReference

author string? (default ()) - Search parameter for author (reference) - DocumentReference

custodian string? (default ()) - Search parameter for custodian (reference) - DocumentReference

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated parameter consists of a comparator (eq, gt, lt, ge and le) and a date (format: YYYY-MM-DD)

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by athena Chart Sharing Group for resources containing the 'athena Chart Sharing Group' Extension

ah_published_date_time_to_portal string? (default ()) - Search parameter for ah-published-date-time-to-portal (date) - Search by athenahealth Published Date Time To Portal (e

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getEncounterById

Remote Function

function getEncounterById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Encounter resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchEncounter

Remote Function

function searchEncounter(string? _id, string? patient, string? date, string? _revinclude, string? _include, string? _count, string? cursor, string? ah_chart_sharing_group, string? ah_practice, string[]? _lastUpdated, string? location, string? service_provider, string? practitioner, string? _security) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - Encounter

patient string? (default ()) - Search parameter for patient (reference) - Encounter

date string? (default ()) - Search parameter for date (date) - Encounter

_revinclude string? (default ()) - Search parameter for _revinclude (special) - Encounter

_include string? (default ()) - Search parameter for _include (special) - Encounter

_count string? (default ()) - Search parameter for _count (number) - The number of Encounter resources to return per page for paged search results

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by Athena Chart Sharing Group for resources containing the 'Athena Chart Sharing Group' Extension

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated date associated with the encounter (format: YYYY-MM-DD)

location string? (default ()) - Search parameter for location (reference) - Encounter

service_provider string? (default ()) - Search parameter for service-provider (reference) - Encounter

practitioner string? (default ()) - Search parameter for practitioner (reference) - Encounter

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getGoalById

Remote Function

function getGoalById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Goal resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchGoal

Remote Function

function searchGoal(string? patient, string? _count, string? _id, string? _revinclude, string? _include, string[]? _lastUpdated, string? cursor, string? ah_brand, string? ah_chart_sharing_group, string? ah_practice, string? ah_department, string? ah_provider_group, string? _security) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - Goal

_count string? (default ()) - Search parameter for _count (number) - The number of Goal resources to return per page for paged search results

_id string? (default ()) - Search parameter for _id (token) - Goal

_revinclude string? (default ()) - Search parameter for _revinclude (special) - Goal

_include string? (default ()) - Search parameter for _include (special) - Goal

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated date associated with the Goal (format: YYYY-MM-DD)

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return

ah_brand string? (default ()) - Search parameter for ah-brand (reference) - Search by Athena Brand for resources containing the 'Athena Brand' Extension

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by Athena Chart Sharing Group for resources containing the 'Athena Chart Sharing Group' Extension

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

ah_department string? (default ()) - Search parameter for ah-department (reference) - Search by Athena Department for resources containing the 'Athena Department' Extension

ah_provider_group string? (default ()) - Search parameter for ah-provider-group (reference) - Search by Athena Provider Group for resources containing the 'Athena Provider Group' Extension

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getImmunizationById

Remote Function

function getImmunizationById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Immunization resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchImmunization

Remote Function

function searchImmunization(string? _include, string? encounter, string? patient, string? date, string? status, string? _revinclude, string? _id, string? _count, string? cursor, string? ah_chart_sharing_group, string? ah_practice, string[]? _lastUpdated, string? vaccine_code, string? _security) returns FHIRResponse|FHIRError

Parameters

_include string? (default ()) - Search parameter for _include (special) - Resource reference to FHIR referenced resources - use with patient

encounter string? (default ()) - Search parameter for encounter (reference) - Resource reference to FHIR Encounter resource - use with patient

patient string? (default ()) - Search parameter for patient (reference) - Reference to patient related to the resource

date string? (default ()) - Search parameter for date (date) - occurence date - use with patient

status string? (default ()) - Search parameter for status (token) - Vaccine status - use with patient

_revinclude string? (default ()) - Search parameter for _revinclude (special) - Resource reference to FHIR Provenance resource - use with patient

_id string? (default ()) - Search parameter for _id (token) - Immunization

_count string? (default ()) - Search parameter for _count (number) - The number of Immunization resources to return per page for paged search results

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return - use with patient

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by Athena Chart Sharing Group for resources containing the 'Athena Chart Sharing Group' Extension - use with patient

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Brand for resources containing the 'Athena Practice' Extension - use with patient

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated date associated with the Immunization

vaccine_code string? (default ()) - Search parameter for vaccine-code (token) - Code associated with vaccine Product Administered

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getLocationById

Remote Function

function getLocationById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Location resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchLocation

Remote Function

function searchLocation(string? _id, string? ah_provider_group, string? ah_chart_sharing_group, string? ah_practice, string? _security) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - Location

ah_provider_group string? (default ()) - Search parameter for ah-provider-group (reference) - Search by Athena Provider Group for resources containing the 'Athena Provider Group' Extension

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by Athena Chart Sharing Group for resources containing the 'Athena Chart Sharing Group' Extension

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getMedicationById

Remote Function

function getMedicationById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Medication resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchMedication

Remote Function

function searchMedication(string? _id, string? ingredient_code, string? ah_practice, string? _security) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - Medication

ingredient_code string? (default ()) - Search parameter for ingredient-code (token) - Resource reference to FHIR Medication ingredient resource

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getMedicationRequestById

Remote Function

function getMedicationRequestById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the MedicationRequest resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchMedicationRequest

Remote Function

function searchMedicationRequest(string? patient, string? intent, string? status, string? _id, string? authoredon, string? _include, string? medication, string? subject, string? encounter, string? requester, string? ah_chart_sharing_group, string? ah_practice, string? _revinclude, string? _count, string? code, string? cursor, string[]? _lastUpdated, string? ingredient_code, string? ah_most_recent_medication_instance_and_prescribed_vaccines, string? _security) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - Reference to a patient related to the prescription - use with intent

intent string? (default ()) - Search parameter for intent (token) - Intent type of the prescription - use with patient

status string? (default ()) - Search parameter for status (token) - Prescription status - use with patient and intent

_id string? (default ()) - Search parameter for _id (token) - MedicationRequest

authoredon string? (default ()) - Search parameter for authoredon (date) - Prescription creation date - use with patient and intent

_include string? (default ()) - Search parameter for _include (special) - Resource reference to FHIR Medication resource - use with patient and intent

medication string? (default ()) - Search parameter for medication (reference) - Resource reference to FHIR Medication resource

subject string? (default ()) - Search parameter for subject (reference) - Resource reference to FHIR patient resource

encounter string? (default ()) - Search parameter for encounter (reference) - Resource reference to FHIR encounter resource

requester string? (default ()) - Search parameter for requester (reference) - Resource reference to FHIR practitioner resource

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by Athena Brand for resources containing the 'Athena Chart Sharing Group' Extension - use with patient and intent

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Brand for resources containing the 'Athena Practice' Extension - use with patient and intent

_revinclude string? (default ()) - Search parameter for _revinclude (special) - Resource reference to FHIR Provenance resource - use with patient and intent

_count string? (default ()) - Search parameter for _count (number) - The number of MedicationRequest resources to return per page for paged search results

code string? (default ()) - Search parameter for code (token) - The MedicationRequest resources to return for the RXNORM code

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return - use with patient and intent

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated date associated with the medication

ingredient_code string? (default ()) - Search parameter for ingredient-code (token) - Resource reference to FHIR Medication resource

ah_most_recent_medication_instance_and_prescribed_vaccines string? (default ()) - Search parameter for ah-most-recent-medication-instance-and-prescribed-vaccines (token) - Returns the most recent instance of the medication and prescribed vaccines

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getObservationById

Remote Function

function getObservationById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Observation resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchObservation

Remote Function

function searchObservation(string? _id, string? patient, string? _revinclude, string? _include, string? date, string? category, string? code, string? encounter, string? _count, string? cursor, string? ah_chart_sharing_group, string? ah_practice, string[]? _lastUpdated, string? _security) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - Observation

patient string? (default ()) - Search parameter for patient (reference) - Observation

_revinclude string? (default ()) - Search parameter for _revinclude (special) - Observation

_include string? (default ()) - Search parameter for _include (special) - Observation

date string? (default ()) - Search parameter for date (date) - Observation

category string? (default ()) - Search parameter for category (token) - Observation

code string? (default ()) - Search parameter for code (token) - Observation

encounter string? (default ()) - Search parameter for encounter (reference) - Observation

_count string? (default ()) - Search parameter for _count (number) - The number of Observation resources to return per page for paged search results

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by athena Chart Sharing Group for resources containing the 'athena Chart Sharing Group' Extension

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by athena Practice for resources containing the 'athena Practice' Extension

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated parameter consists of a comparator (eq, gt, lt, ge and le) and a date (format: YYYY-MM-DD)

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getOrganizationById

Remote Function

function getOrganizationById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Organization resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchOrganization

Remote Function

function searchOrganization(string? _id, string? ah_provider_group, string? ah_chart_sharing_group, string? ah_practice, string? _security) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - Organization

ah_provider_group string? (default ()) - Search parameter for ah-provider-group (reference) - Search by Athena Provider Group for resources containing the 'Athena Provider Group' Extension

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by Athena Chart Sharing Group for resources containing the 'Athena Chart Sharing Group' Extension

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getPatientById

Remote Function

function getPatientById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Patient resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchPatient

Remote Function

function searchPatient(string? _id, string? identifier, string? name, string? birthdate, string? gender, string? family, string? given, string[]? _lastUpdated, string? ah_brand, string? ah_chart_sharing_group, string? ah_department, string? ah_provider_group, string? _count, string? cursor, string? _include, string? _revinclude, string? ah_practice, string? _security) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - Patient

identifier string? (default ()) - Search parameter for identifier (token) - A patient identifier

name string? (default ()) - Search parameter for name (string) - A server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, suffix, and/or text

birthdate string? (default ()) - Search parameter for birthdate (date) - The patient's date of birth

gender string? (default ()) - Search parameter for gender (token) - Gender of the patient

family string? (default ()) - Search parameter for family (string) - A portion of the family name of the patient

given string? (default ()) - Search parameter for given (string) - A portion of the given name of the patient

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated date of the patient (_lastUpdated may only be used in conjunction with other supported search parameter combinations)

ah_brand string? (default ()) - Search parameter for ah-brand (reference) - Search by Athena Brand for resources containing the 'Athena Brand' Extension

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by Athena Chart Sharing Group for resources containing the 'Athena Chart Sharing Group' Extension

ah_department string? (default ()) - Search parameter for ah-department (reference) - Search by Athena Department for resources containing the 'Athena Department' Extension

ah_provider_group string? (default ()) - Search parameter for ah-provider-group (reference) - Search by Athena Provider Group for resources containing the 'Athena Provider Group' Extension

_count string? (default ()) - Search parameter for _count (number) - The number of Patient resources to return per page for paged search results

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return

_include string? (default ()) - Search parameter for _include (special) - Include resources that reference specified value

_revinclude string? (default ()) - Search parameter for _revinclude (special) - Other resources to include in the search results when they refer to search matches

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

healthCardsIssuePatientOperation

Remote Function

function healthCardsIssuePatientOperation(RequestMode mode, string? id, map<string[]>? queryParameters, json|xml? data) returns FHIRResponse|FHIRError

Parameters

mode RequestMode (default fhirClient:POST) -

id string? (default ()) -

queryParameters map<string[]>? (default ()) -

data json|xml? (default ()) -

getPractitionerById

Remote Function

function getPractitionerById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Practitioner resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchPractitioner

Remote Function

function searchPractitioner(string? _id, string? ah_provider_group, string? identifier, string? ah_practice, string? _security) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - Practitioner

ah_provider_group string? (default ()) - Search parameter for ah-provider-group (reference) - Search by Athena Provider Group for resources containing the 'Athena Provider Group' Extension

identifier string? (default ()) - Search parameter for identifier (token) - Search by athenaNet username identifier (e

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athenahealth Practice for resources under a specific practice

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getProcedureById

Remote Function

function getProcedureById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Procedure resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchProcedure

Remote Function

function searchProcedure(string? patient, string? date, string? _revinclude, string? _count, string? cursor, string? ah_chart_sharing_group, string? encounter, string? _include, string? performer, string? ah_provider_group, string? device_name, string? _id, string[]? _lastUpdated, string? ah_practice, string? _security) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - Procedure

date string? (default ()) - Search parameter for date (date) - Procedure

_revinclude string? (default ()) - Search parameter for _revinclude (special) - Procedure

_count string? (default ()) - Search parameter for _count (number) - The number of Procedure resources to return per page for paged search results

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by Athena Chart Sharing Group for resources containing the 'Athena Chart Sharing Group' Extension'

encounter string? (default ()) - Search parameter for encounter (reference) - Procedure

_include string? (default ()) - Search parameter for _include (special) - Procedure

performer string? (default ()) - Search parameter for performer (reference) - Procedure

ah_provider_group string? (default ()) - Search parameter for ah-provider-group (reference) - Search by Athena Provider Group for resources containing the 'Athena Provider Group' Extension

device_name string? (default ()) - Search parameter for device-name (reference) - Procedure

_id string? (default ()) - Search parameter for _id (token) - Procedure

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated date associated with the procedure (format: YYYY-MM-DD)

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getProvenanceById

Remote Function

function getProvenanceById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Provenance resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchProvenance

Remote Function

function searchProvenance(string? target, string? _include, string? ah_practice, string? _security) returns FHIRResponse|FHIRError

Parameters

target string? (default ()) - Search parameter for target (reference) - Provenance

_include string? (default ()) - Search parameter for _include (special) - Provenance

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getServiceRequestById

Remote Function

function getServiceRequestById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the ServiceRequest resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchServiceRequest

Remote Function

function searchServiceRequest(string? _id, string? encounter, string? patient, string? _count, string? status, string? authored, string[]? _lastUpdated, string? cursor, string? performer, string? requester, string? _include, string? _revinclude, string? ah_chart_sharing_group, string? ah_practice, string? code, string? category, string? _security) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - ServiceRequest

encounter string? (default ()) - Search parameter for encounter (reference) - Resource reference to FHIR Encounter resource

patient string? (default ()) - Search parameter for patient (reference) - ServiceRequest

_count string? (default ()) - Search parameter for _count (number) - The number of ServiceRequest resources to return per page for paged search results

status string? (default ()) - Search parameter for status (token) - ServiceRequest

authored string? (default ()) - Search parameter for authored (date) - ServiceRequest

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Last updated parameter for searching service requests resources by the last time that they changed

cursor string? (default ()) - Search parameter for cursor (token) - An identifier for the first resource to return

performer string? (default ()) - Search parameter for performer (reference) - ServiceRequest

requester string? (default ()) - Search parameter for requester (reference) - ServiceRequest

_include string? (default ()) - Search parameter for _include (special) - ServiceRequest

_revinclude string? (default ()) - Search parameter for _revinclude (special) - ServiceRequest

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - Search by athena Chart Sharing Group for resources containing the 'athena Chart Sharing Group' Extension

ah_practice string? (default ()) - Search parameter for ah-practice (reference) - Search by Athena Practice for resources containing the 'Athena Practice' Extension

code string? (default ()) - Search parameter for code (token) - ServiceRequest

category string? (default ()) - Search parameter for category (token) - ServiceRequest

_security string? (default () ) - Search parameter for _security (token) - Search by a security label

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

exportGroupOperation

Remote Function

function exportGroupOperation(RequestMode mode, string? id, map<string[]>? queryParameters, json|xml? data) returns FHIRResponse|FHIRError

Parameters

mode RequestMode (default fhirClient:POST) -

id string? (default ()) -

queryParameters map<string[]>? (default ()) -

data json|xml? (default ()) -

createQuestionnaireResponse

Remote Function

function createQuestionnaireResponse(QuestionnaireResponse newQuestionnaireResponse) returns FHIRResponse|FHIRError

Parameters

newQuestionnaireResponse QuestionnaireResponse - A new instance of the QuestionnaireResponse resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchQuestionnaireResponse

Remote Function

function searchQuestionnaireResponse(string? _id, string[]? _lastUpdated, string? ah_chart_sharing_group, string? ah_practice, string? authored, string? encounter, string? patient, string? questionnaireCode, string? status) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - The ID of the resource

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Only return resources which were last updated as specified by the given range

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) -

ah_practice string? (default ()) - Search parameter for ah-practice (reference) -

authored string? (default ()) - Search parameter for authored (date) - When the questionnaire response was last changed

encounter string? (default ()) - Search parameter for encounter (reference) - Encounter associated with the questionnaire response

patient string? (default ()) - Search parameter for patient (reference) - The patient that is the subject of the questionnaire response

questionnaireCode string? (default ()) - Search parameter for questionnaireCode (token) -

status string? (default () ) - Search parameter for status (string) - The status of the questionnaire response

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getQuestionnaireResponseById

Remote Function

function getQuestionnaireResponseById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the QuestionnaireResponse resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

latestResponseByQuestionnaireQuestionnaireResponseOperation

Remote Function

function latestResponseByQuestionnaireQuestionnaireResponseOperation(RequestMode mode, string? id, map<string[]>? queryParameters, json|xml? data) returns FHIRResponse|FHIRError

Parameters

mode RequestMode (default fhirClient:POST) -

id string? (default ()) -

queryParameters map<string[]>? (default ()) -

data json|xml? (default ()) -

submitCareGapsMeasureReportOperation

Remote Function

function submitCareGapsMeasureReportOperation(RequestMode mode, string? id, map<string[]>? queryParameters, json|xml? data) returns FHIRResponse|FHIRError

Parameters

mode RequestMode (default fhirClient:POST) -

id string? (default ()) -

queryParameters map<string[]>? (default ()) -

data json|xml? (default ()) -

getMediaById

Remote Function

function getMediaById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Media resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchMedicationDispense

Remote Function

function searchMedicationDispense(string? _id, string[]? _lastUpdated, string? ah_chart_sharing_group, string? ah_practice, string? date, string? patient, string? status) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - The ID of the resource

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Only return resources which were last updated as specified by the given range

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) -

ah_practice string? (default ()) - Search parameter for ah-practice (reference) -

date string? (default ()) - Search parameter for date (date) -

patient string? (default ()) - Search parameter for patient (reference) - The identity of a patient to list dispenses for

status string? (default () ) - Search parameter for status (token) - Returns dispenses with a specified dispense status

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getMedicationDispenseById

Remote Function

function getMedicationDispenseById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the MedicationDispense resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchSpecimen

Remote Function

function searchSpecimen(string? _id, string[]? _lastUpdated, string? ah_chart_sharing_group, string? patient) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - The ID of the resource

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Only return resources which were last updated as specified by the given range

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) -

patient string? (default () ) - Search parameter for patient (reference) - The patient the specimen comes from

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getSpecimenById

Remote Function

function getSpecimenById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Specimen resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

searchRelatedPerson

Remote Function

function searchRelatedPerson(string? patient, string[]? _lastUpdated, string? active, string? ah_brand, string? ah_chart_sharing_group, string? ah_provider_group, string? name, string? _id) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - The patient this related person is related to

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Only return resources which were last updated as specified by the given range

active string? (default ()) - Search parameter for active (token) - Indicates if the related person record is active

ah_brand string? (default ()) - Search parameter for ah-brand (reference) - The brand extension this related person belongs to

ah_chart_sharing_group string? (default ()) - Search parameter for ah-chart-sharing-group (reference) - The chart sharing group this related person belongs to

ah_provider_group string? (default ()) - Search parameter for ah-provider-group (reference) - The provider group this related person belongs to

name string? (default ()) - Search parameter for name (string) - A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

_id string? (default () ) - Search parameter for _id (string) - The ID of the resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

getRelatedPersonById

Remote Function

function getRelatedPersonById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the RelatedPerson resource

Return Type

FHIRResponse|FHIRError - Returns a FHIRResponse or FHIRError for the operation

Import

import ballerinax/health.clients.fhir.athenahealth;

Other versions

1.0.0

Metadata

Released date: 1 day ago

Version: 1.0.0

Compatibility

Platform: any

Ballerina version: 2201.12.3

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Keywords

Area/Healthcare

Industry/Healthcare

Type/Connector

Vendor/AthenaHealth

AthenaHealth FHIR Connector

Dependencies

ballerinax/health.fhir.r4.international401/4.0.2 ballerinax/health.clients.fhir/3.0.4

Cookie policy

Delete policy