Module health.clients.fhir.cerner

ballerinax/health.clients.fhir.cerner 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://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/metadata?_format=application/json

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
CapabilityStatement	`read`	-
Account	`read` `search-type`	-
AllergyIntolerance	`read` `search-type` `create` `update`	-
Appointment	`read` `search-type` `create` `patch`	-
Basic	`create`	-
Binary	`read`	`autogen-ccd-if`
CarePlan	`read` `search-type`	-
CareTeam	`read` `search-type`	-
ChargeItem	`read` `search-type`	`modify` `create` `credit`
Communication	`read` `search-type` `create` `patch`	-
Condition	`read` `search-type` `create` `update`	-
Consent	`read` `search-type`	-
Coverage	`read` `search-type` `create` `patch` `delete`	-
Device	`read` `search-type`	-
DiagnosticReport	`read` `search-type` `create`	-
DocumentReference	`read` `search-type` `create` `update`	`USCoreFetchDocumentReferences`
Encounter	`read` `search-type` `create` `patch`	-
FamilyMemberHistory	`read` `search-type` `create` `update`	-
Goal	`read` `search-type`	-
Group		`export`
Immunization	`read` `search-type` `create` `update`	-
InsurancePlan	`read` `search-type`	-
Location	`read` `search-type`	-
Media	`read`	-
MedicationAdministration	`read` `search-type`	-
MedicationDispense	`read` `search-type`	-
MedicationRequest	`read` `search-type` `create` `patch`	-
NutritionOrder	`read` `search-type`	-
Observation	`read` `search-type` `create` `update`	-
OperationDefinition	`read`	-
Organization	`read` `search-type` `create`	`get-cg-for-mrcu`
Patient	`read` `search-type` `create` `patch`	`health-cards-issue` `export`
Person	`read` `search-type`	-
Practitioner	`read` `search-type` `create`	-
Procedure	`read` `search-type` `create`	-
Provenance	`read` `search-type` `create`	-
Questionnaire	`read` `search-type`	-
QuestionnaireResponse	`read` `search-type` `update`	-
RelatedPerson	`read` `search-type` `create` `patch`	-
Schedule	`read` `search-type`	-
ServiceRequest	`read` `search-type`	-
Slot	`read` `search-type` `patch`	-
Specimen	`read` `search-type`	-
StructureDefinition	`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 <package>/cerner.fhir.connector;
import ballerina/io;


public function main() returns error? {
    // Initialize the Cerner connector client
    fhirClient:FHIRConnectorConfig cernerConfig = {
        baseURL: base,
        mimeType: fhirClient:FHIR_JSON,
        authConfig: {
            tokenUrl: tokenUrl,
            clientId: clientId,
            clientSecret: clientSecret,
            scopes: scopes
        }
    };
    connector:FHIRClientConnector cernerFhirclientconnector = check new (cernerConfig);
    
    // Example 1: Read a patient by ID
    fhirClient:FHIRResponse patientResult = check cernerFhirclientconnector->getPatientById("12724067");
    io:println("[FHIR GET] Patient resource by ID (12724067): ", patientResult.'resource);
    
    // Example 2: Search Encounters by Patient
    fhirClient:FHIRResponse encounterResult = check cernerFhirclientconnector->searchEncounter(patient = "12724066");
    io:println("[FHIR SEARCH] Encounter resources for Patient ID (12724067): ", encounterResult.'resource);
}

Clients

health.clients.fhir.cerner: FHIRClientConnector

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

getCapabilityStatementById

Remote Function

function getCapabilityStatementById(string id) returns FHIRResponse|FHIRError

Auto-generated operations

Parameters

id string - The logical ID of the CapabilityStatement resource

Return Type

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

getAccountById

Remote Function

function getAccountById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Account resource

Return Type

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

searchAccount

Remote Function

function searchAccount(string? _id, string? patient, string? _encounter, string? _guarantor, string? 'type, string? identifier, string? _count) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Account ids

patient string? (default ()) - Search parameter for patient (reference) - The entity that caused the expenses

_encounter string? (default ()) - Search parameter for -encounter (reference) - The encounter associated with the resource

_guarantor string? (default ()) - Search parameter for -guarantor (reference) - The entity that responsible for payment

'type string? (default ()) - Search parameter for type (token) - The identifier for the account

identifier string? (default ()) - Search parameter for identifier (token) - Statement Account number

_count string? (default () ) - Search parameter for _count (number) - The maximum number of results to return in a page

Return Type

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

getAllergyIntoleranceById

Remote Function

function getAllergyIntoleranceById(string id) returns FHIRResponse|FHIRError

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? _id, string? patient, string? clinical_status, string[]? _lastUpdated) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of AllergyIntolerance ids

patient string? (default ()) - Search parameter for patient (reference) - Who the sensitivity is for

clinical_status string? (default ()) - Search parameter for clinical-status (token) - Certainty of the allergy or intolerance

_lastUpdated string[]? (default () ) - Search parameter for _lastUpdated (date) - A date or date range used to search for AllergyIntolerance records which were last updated in that period

Return Type

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

createAllergyIntolerance

Remote Function

function createAllergyIntolerance(USCoreAllergyIntolerance newAllergyIntolerance) returns FHIRResponse|FHIRError

Parameters

newAllergyIntolerance USCoreAllergyIntolerance - A new instance of the AllergyIntolerance resource

Return Type

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

updateAllergyIntolerance

Remote Function

function updateAllergyIntolerance(USCoreAllergyIntolerance updatedAllergyIntolerance) returns FHIRResponse|FHIRError

Parameters

updatedAllergyIntolerance USCoreAllergyIntolerance - A new or updated instance of the AllergyIntolerance resource

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? _count, string? date, string? _date_or_req_period, string? patient, string? practitioner, string? location, string? status) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Appointment ids

_count string? (default ()) - Search parameter for _count (number) - The maximum number of results to return in a page

date string? (default ()) - Search parameter for date (date) - A date or date range from which to find appointments

_date_or_req_period string? (default ()) - Search parameter for -date-or-req-period (date) - A start date or requested period from which to find appointments

patient string? (default ()) - Search parameter for patient (reference) - One of the individuals of the appointment is this patient

practitioner string? (default ()) - Search parameter for practitioner (reference) - One of the individuals of the appointment is this practitioner

location string? (default ()) - Search parameter for location (reference) - This location is listed in the participants of the appointment

status string? (default () ) - Search parameter for status (token) - The overall status of the appointment

Return Type

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

createAppointment

Remote Function

function createAppointment(Appointment newAppointment) returns FHIRResponse|FHIRError

Parameters

newAppointment Appointment - A new instance of the Appointment resource

Return Type

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

patchAppointment

Remote Function

function patchAppointment(string id, Appointment patchAppointment) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Appointment resource

patchAppointment Appointment - An updated instance of the Appointment resource

Return Type

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

createBasic

Remote Function

function createBasic(Basic newBasic) returns FHIRResponse|FHIRError

Parameters

newBasic Basic - A new instance of the Basic resource

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

autogenCcdIfBinaryOperation

Remote Function

function autogenCcdIfBinaryOperation(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 ()) -

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? _id, string? date, string? patient, string? category, string? _count) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of CarePlan ids

date string? (default ()) - Search parameter for date (date) - A date range with which to find CarePlans

patient string? (default ()) - Search parameter for patient (reference) - Who the careplan is for

category string? (default ()) - Search parameter for category (token) - The category of the careplan

_count string? (default () ) - Search parameter for _count (number) - The maximum number of results to return

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? _id, string? category, string? encounter, string? patient, string? status) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - CareTeam id supports only the single id

category string? (default ()) - Search parameter for category (token) - The category of the careteam

encounter string? (default ()) - Search parameter for encounter (reference) - The Encounter level CareTeam are displayed

patient string? (default ()) - Search parameter for patient (reference) - Who the careteam is for

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

Return Type

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

getChargeItemById

Remote Function

function getChargeItemById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the ChargeItem resource

Return Type

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

searchChargeItem

Remote Function

function searchChargeItem(string? _id, string? context, string? account, string? _status, string? _count) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - ChargeItem id supports only the single id

context string? (default ()) - Search parameter for context (reference) - Encounter associated with the ChargeItem

account string? (default ()) - Search parameter for account (reference) - Account associated with the ChargeItem

_status string? (default ()) - Search parameter for -status (token) - The status of the ChargeItem

_count string? (default () ) - Search parameter for _count (number) - The maximum number of results to return in a page

Return Type

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

modifyChargeItemOperation

Remote Function

function modifyChargeItemOperation(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 ()) -

createChargeItemOperation

Remote Function

function createChargeItemOperation(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 ()) -

creditChargeItemOperation

Remote Function

function creditChargeItemOperation(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 ()) -

getCommunicationById

Remote Function

function getCommunicationById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Communication resource

Return Type

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

searchCommunication

Remote Function

function searchCommunication(string? _id, string? category, string? received, string? recipient, string? _email_status) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Communication ids

category string? (default ()) - Search parameter for category (token) - The message category

received string? (default ()) - Search parameter for received (date) - When the message is received

recipient string? (default ()) - Search parameter for recipient (reference) - The recipient of the message

_email_status string? (default () ) - Search parameter for -email-status (token) - The email status of the message

Return Type

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

createCommunication

Remote Function

function createCommunication(Communication newCommunication) returns FHIRResponse|FHIRError

Parameters

newCommunication Communication - A new instance of the Communication resource

Return Type

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

patchCommunication

Remote Function

function patchCommunication(string id, Communication patchCommunication) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Communication resource

patchCommunication Communication - An updated instance of the Communication resource

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? subject, string? clinical_status, string? category, string[]? _lastUpdated) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Condition ids

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

encounter string? (default ()) - Search parameter for encounter (reference) - The encounter of the patient

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

clinical_status string? (default ()) - Search parameter for clinical-status (token) - The clinical status of the condition

category string? (default ()) - Search parameter for category (token) - The category of the condition

_lastUpdated string[]? (default () ) - Search parameter for _lastUpdated (date) - A date or date range used to search for conditions which were last updated in that period

Return Type

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

createCondition

Remote Function

function createCondition(Condition|USCoreConditionEncounterDiagnosisProfile|USCoreConditionProblemsHealthConcernsProfile newCondition) returns FHIRResponse|FHIRError

Parameters

newCondition Condition|USCoreConditionEncounterDiagnosisProfile|USCoreConditionProblemsHealthConcernsProfile - A new instance of the Condition resource

Return Type

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

updateCondition

Remote Function

function updateCondition(Condition|USCoreConditionEncounterDiagnosisProfile|USCoreConditionProblemsHealthConcernsProfile updatedCondition) returns FHIRResponse|FHIRError

Parameters

updatedCondition Condition|USCoreConditionEncounterDiagnosisProfile|USCoreConditionProblemsHealthConcernsProfile - A new or updated instance of the Condition resource

Return Type

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

getConsentById

Remote Function

function getConsentById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Consent resource

Return Type

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

searchConsent

Remote Function

function searchConsent(string? _id, string? patient, string? actor, string? patient_identifier, string? actor_identifier) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Consent ids

patient string? (default ()) - Search parameter for patient (reference) - Who the consent applies to

actor string? (default ()) - Search parameter for actor (reference) - Resource for the actor (or group, by role)

patient_identifier string? (default ()) - Search parameter for patient.identifier (token) - The patient

actor_identifier string? (default () ) - Search parameter for actor.identifier (token) - The actor

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? _id, string? patient, string? _encounter) returns FHIRResponse|FHIRError

Parameters

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

patient string? (default ()) - Search parameter for patient (reference) - Retrieve coverages for a patient

_encounter string? (default () ) - Search parameter for -encounter (reference) - Retrieve coverages for an encounter

Return Type

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

createCoverage

Remote Function

function createCoverage(USCoreCoverageProfile newCoverage) returns FHIRResponse|FHIRError

Parameters

newCoverage USCoreCoverageProfile - A new instance of the Coverage resource

Return Type

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

patchCoverage

Remote Function

function patchCoverage(string id, USCoreCoverageProfile patchCoverage) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Coverage resource

patchCoverage USCoreCoverageProfile - An updated instance of the Coverage resource

Return Type

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

deleteCoverage

Remote Function

function deleteCoverage(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

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? _id, string? patient) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Device ids

patient string? (default () ) - Search parameter for patient (reference) - The patient to whom Device is affixed

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? category, string? code, string? encounter, string? patient, string? date, string[]? _lastUpdated, string? _count) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of DiagnosticReport ids

category string? (default ()) - Search parameter for category (token) - Which diagnostic discipline/department created the report

code string? (default ()) - Search parameter for code (token) - The code for the report

encounter string? (default ()) - Search parameter for encounter (reference) - The Encounter when the report was made

patient string? (default ()) - Search parameter for patient (reference) - The subject of the report

date string? (default ()) - Search parameter for date (date) - A date range with which to find Documents

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - A date or date range used to search for Documents of diagnostic report which were last updated in that period

_count string? (default () ) - Search parameter for _count (number) - The maximum number of results to return in a page

Return Type

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

createDiagnosticReport

Remote Function

function createDiagnosticReport(USCoreDiagnosticReportProfileNoteExchange|USCoreDiagnosticReportProfileLaboratoryReporting newDiagnosticReport) returns FHIRResponse|FHIRError

Parameters

newDiagnosticReport USCoreDiagnosticReportProfileNoteExchange|USCoreDiagnosticReportProfileLaboratoryReporting - A new instance of the DiagnosticReport resource

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? encounter, string? period, string? _count, string? 'type, string? category, string? date, string[]? _lastUpdated) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of DocumentReference ids

patient string? (default ()) - Search parameter for patient (reference) - The patient the document is about

encounter string? (default ()) - Search parameter for encounter (reference) - The Encounter in which the document was created

period string? (default ()) - Search parameter for period (date) - A date range with which to find Documents

_count string? (default ()) - Search parameter for _count (number) - The maximum number of results to return in a page

'type string? (default ()) - Search parameter for type (token) - The kind of document (LOINC if possible)

category string? (default ()) - Search parameter for category (token) - The categorization of document

date string? (default ()) - Search parameter for date (date) - It must be provided once with a prefix to imply a date range or without a prefix to search for document(s) at a specific date

_lastUpdated string[]? (default () ) - Search parameter for _lastUpdated (date) - A date or date range used to search for Documents which were last updated in that period

Return Type

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

createDocumentReference

Remote Function

function createDocumentReference(USCoreDocumentReferenceProfile newDocumentReference) returns FHIRResponse|FHIRError

Parameters

newDocumentReference USCoreDocumentReferenceProfile - A new instance of the DocumentReference resource

Return Type

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

updateDocumentReference

Remote Function

function updateDocumentReference(USCoreDocumentReferenceProfile updatedDocumentReference) returns FHIRResponse|FHIRError

Parameters

updatedDocumentReference USCoreDocumentReferenceProfile - A new or updated instance of the DocumentReference resource

Return Type

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

uscorefetchdocumentreferencesDocumentReferenceOperation

Remote Function

function uscorefetchdocumentreferencesDocumentReferenceOperation(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 ()) -

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? _count, string? patient, string? subject, string? status, string? date, string? identifier, string? account, string[]? _lastUpdated) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Encounter ids

_count string? (default ()) - Search parameter for _count (number) - The maximum number of results to return in a page

patient string? (default ()) - Search parameter for patient (reference) - The patient present at the encounter

subject string? (default ()) - Search parameter for subject (reference) - The patient present at the encounter

status string? (default ()) - Search parameter for status (token) - The status of the encounter

date string? (default ()) - Search parameter for date (date) - A date parameter may be provided once with a prefix and time component to imply a date range

identifier string? (default ()) - Search parameter for identifier (token) - An encounter's identifier

account string? (default ()) - Search parameter for account (reference) - The account associated with the encounters

_lastUpdated string[]? (default () ) - Search parameter for _lastUpdated (date) - A date or date range used to search for Encounter records which were last updated in that period

Return Type

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

createEncounter

Remote Function

function createEncounter(USCoreEncounterProfile newEncounter) returns FHIRResponse|FHIRError

Parameters

newEncounter USCoreEncounterProfile - A new instance of the Encounter resource

Return Type

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

patchEncounter

Remote Function

function patchEncounter(string id, USCoreEncounterProfile patchEncounter) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Encounter resource

patchEncounter USCoreEncounterProfile - An updated instance of the Encounter resource

Return Type

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

getFamilyMemberHistoryById

Remote Function

function getFamilyMemberHistoryById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the FamilyMemberHistory resource

Return Type

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

searchFamilyMemberHistory

Remote Function

function searchFamilyMemberHistory(string? _id, string? patient, string? status) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of FamilyMemberHistory ids

patient string? (default ()) - Search parameter for patient (reference) - Who the family member history is for

status string? (default () ) - Search parameter for status (token) - The status of the FamilyMemberHistory

Return Type

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

createFamilyMemberHistory

Remote Function

function createFamilyMemberHistory(FamilyMemberHistory newFamilyMemberHistory) returns FHIRResponse|FHIRError

Parameters

newFamilyMemberHistory FamilyMemberHistory - A new instance of the FamilyMemberHistory resource

Return Type

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

updateFamilyMemberHistory

Remote Function

function updateFamilyMemberHistory(FamilyMemberHistory updatedFamilyMemberHistory) returns FHIRResponse|FHIRError

Parameters

updatedFamilyMemberHistory FamilyMemberHistory - A new or updated instance of the FamilyMemberHistory resource

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? _id, string? patient, string? target_date) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - Goal id supports only the single id

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

target_date string? (default () ) - Search parameter for target-date (date) - A date or date range from which to find Goals

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 ()) -

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? _id, string? patient, string[]? _lastUpdated, string? date, string? target_disease) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Immunization ids

patient string? (default ()) - Search parameter for patient (reference) - The patient for the vaccination record

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - Vaccination LastUpdated Date

date string? (default ()) - Search parameter for date (date) - Vaccination (non)-Administration Date

target_disease string? (default () ) - Search parameter for target-disease (token) - A single or comma separated list of target diseases the dose is being administered against

Return Type

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

createImmunization

Remote Function

function createImmunization(USCoreImmunizationProfile newImmunization) returns FHIRResponse|FHIRError

Parameters

newImmunization USCoreImmunizationProfile - A new instance of the Immunization resource

Return Type

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

updateImmunization

Remote Function

function updateImmunization(USCoreImmunizationProfile updatedImmunization) returns FHIRResponse|FHIRError

Parameters

updatedImmunization USCoreImmunizationProfile - A new or updated instance of the Immunization resource

Return Type

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

getInsurancePlanById

Remote Function

function getInsurancePlanById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the InsurancePlan resource

Return Type

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

searchInsurancePlan

Remote Function

function searchInsurancePlan(string? _id, string? owned_by) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of InsurancePlan ids

owned_by string? (default () ) - Search parameter for owned-by (reference) - The organization that is providing the health insurance product

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? _physicalType, string? identifier, string? address, string? address_city, string? address_state, string? address_postalcode, string? name, string? organization, string? 'type) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Location ids

_physicalType string? (default ()) - Search parameter for -physicalType (token) - The Location's physical type

identifier string? (default ()) - Search parameter for identifier (token) - A location's identifier

address string? (default ()) - Search parameter for address (string) - A (part of the) address of the location

address_city string? (default ()) - Search parameter for address-city (string) - A city specified in an address

address_state string? (default ()) - Search parameter for address-state (string) - A state specified in an address

address_postalcode string? (default ()) - Search parameter for address-postalcode (string) - A postal code specified in an address

name string? (default ()) - Search parameter for name (string) - A portion of the location's name or alias

organization string? (default ()) - Search parameter for organization (reference) - Searches for locations that are managed by the provided organization

'type string? (default () ) - Search parameter for type (token) - The Location's type

Return Type

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

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

getMedicationAdministrationById

Remote Function

function getMedicationAdministrationById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the MedicationAdministration resource

Return Type

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

searchMedicationAdministration

Remote Function

function searchMedicationAdministration(string? _id, string? patient, string? status, string? performer, string? effective_time) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of MedicationAdministration ids

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

status string? (default ()) - Search parameter for status (token) - MedicationAdministration event status

performer string? (default ()) - Search parameter for performer (reference) - The identity of the individual who administered the medication

effective_time string? (default () ) - Search parameter for effective-time (date) - A effective-time parameter may be provided once with 'le' or 'lt' or 'ge' or 'gt' prefix and time component to imply a date range

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

searchMedicationDispense

Remote Function

function searchMedicationDispense(string? _id, string? patient, string? _count) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of MedicationDispense ids

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

_count string? (default () ) - Search parameter for _count (number) - The maximum number of results to return

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? _id, string? patient, string? intent, string? status, string[]? _lastUpdated, string? _timing_boundsPeriod, string? _count) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of MedicationRequest ids

patient string? (default ()) - Search parameter for patient (reference) - The patient to return MedicationRequests for

intent string? (default ()) - Search parameter for intent (token) - The intent of the MedicationRequest

status string? (default ()) - Search parameter for status (token) - The status of the MedicationRequest

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - When the resource version last changed

_timing_boundsPeriod string? (default ()) - Search parameter for -timing-boundsPeriod (date) - The date-time within the period the medication should be given to the patient

_count string? (default () ) - Search parameter for _count (number) - The maximum number of results to return in a page

Return Type

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

createMedicationRequest

Remote Function

function createMedicationRequest(USCoreMedicationRequestProfile newMedicationRequest) returns FHIRResponse|FHIRError

Parameters

newMedicationRequest USCoreMedicationRequestProfile - A new instance of the MedicationRequest resource

Return Type

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

patchMedicationRequest

Remote Function

function patchMedicationRequest(string id, USCoreMedicationRequestProfile patchMedicationRequest) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the MedicationRequest resource

patchMedicationRequest USCoreMedicationRequestProfile - An updated instance of the MedicationRequest resource

Return Type

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

getNutritionOrderById

Remote Function

function getNutritionOrderById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the NutritionOrder resource

Return Type

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

searchNutritionOrder

Remote Function

function searchNutritionOrder(string? _id, string? patient, string? status, string[]? _lastUpdated, string? _count) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of NutritionOrder ids

patient string? (default ()) - Search parameter for patient (reference) - The patient to return NutritionOrders for

status string? (default ()) - Search parameter for status (token) - The status of the NutritionOrder

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - When the resource version last changed

_count string? (default () ) - Search parameter for _count (number) - The maximum number of results to return in a page

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? subject, string? category, string? code, string? date, string[]? _lastUpdated, string? _count) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Observation ids

patient string? (default ()) - Search parameter for patient (reference) - The patient the observation is about

subject string? (default ()) - Search parameter for subject (reference) - The patient subject the observation is about

category string? (default ()) - Search parameter for category (token) - A single or comma separated list of classifications of the type of observation

code string? (default ()) - Search parameter for code (token) - A single or comma separated list of observation types

date string? (default ()) - Search parameter for date (date) - A date or date range from which to find observations

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - A date or date range used to search for observations which were last updated in that period

_count string? (default () ) - Search parameter for _count (number) - The maximum number of results to return in a page

Return Type

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

createObservation

Remote Function

function createObservation(USCoreLaboratoryResultObservationProfile|USCoreBMIProfile|USCorePediatricWeightForHeightObservationProfile|USCorePulseOximetryProfile|USCoreSmokingStatusProfile|USCoreBloodPressureProfile|USCoreBodyHeightProfile|USCoreBodyWeightProfile|USCoreHeartRateProfile|USCoreRespiratoryRateProfile|USCoreBodyTemperatureProfile|USCoreHeadCircumferenceProfile|USCoreVitalSignsProfile|USCorePediatricBMIforAgeObservationProfile|USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfile|USCoreObservationOccupationProfile|USCoreObservationPregnancyStatusProfile|USCoreObservationPregnancyIntentProfile|Observation|USCoreObservationClinicalResultProfile|USCoreObservationScreeningAssessmentProfile|USCoreObservationSexualOrientationProfile newObservation) returns FHIRResponse|FHIRError

Return Type

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

updateObservation

Remote Function

function updateObservation(USCoreLaboratoryResultObservationProfile|USCoreBMIProfile|USCorePediatricWeightForHeightObservationProfile|USCorePulseOximetryProfile|USCoreSmokingStatusProfile|USCoreBloodPressureProfile|USCoreBodyHeightProfile|USCoreBodyWeightProfile|USCoreHeartRateProfile|USCoreRespiratoryRateProfile|USCoreBodyTemperatureProfile|USCoreHeadCircumferenceProfile|USCoreVitalSignsProfile|USCorePediatricBMIforAgeObservationProfile|USCorePediatricHeadOccipitalFrontalCircumferencePercentileProfile|USCoreObservationOccupationProfile|USCoreObservationPregnancyStatusProfile|USCoreObservationPregnancyIntentProfile|Observation|USCoreObservationClinicalResultProfile|USCoreObservationScreeningAssessmentProfile|USCoreObservationSexualOrientationProfile updatedObservation) returns FHIRResponse|FHIRError

Return Type

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

getOperationDefinitionById

Remote Function

function getOperationDefinitionById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the OperationDefinition resource

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? identifier, string? 'type, string? _count, string? name, string? address) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Organization ids

identifier string? (default ()) - Search parameter for identifier (token) - The Organization's Identifier

'type string? (default ()) - Search parameter for type (token) - The Organization's type

_count string? (default ()) - Search parameter for _count (number) - The maximum number of results to return in a page

name string? (default ()) - Search parameter for name (string) - The Organization's name

address string? (default () ) - Search parameter for address (string) - The Organization's address

Return Type

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

createOrganization

Remote Function

function createOrganization(USCoreOrganizationProfile newOrganization) returns FHIRResponse|FHIRError

Parameters

newOrganization USCoreOrganizationProfile - A new instance of the Organization resource

Return Type

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

getCgForMrcuOrganizationOperation

Remote Function

function getCgForMrcuOrganizationOperation(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 ()) -

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? given, string? family, string? address_postalcode, string? birthdate, string? phone, string? email, string? gender, string? _count) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Patient ids

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

name string? (default ()) - Search parameter for name (string) - The beginning of any name of the patient

given string? (default ()) - Search parameter for given (string) - The beginning of the given name of the patient

family string? (default ()) - Search parameter for family (string) - The beginning of the family name of the patient

address_postalcode string? (default ()) - Search parameter for address-postalcode (string) - The postal code of the address of the patient

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

phone string? (default ()) - Search parameter for phone (token) - The value of the phone number of the patient

email string? (default ()) - Search parameter for email (token) - The value of the email address of the patient

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

_count string? (default () ) - Search parameter for _count (number) - The maximum number of results to return in a page

Return Type

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

createPatient

Remote Function

function createPatient(USCorePatientProfile newPatient) returns FHIRResponse|FHIRError

Parameters

newPatient USCorePatientProfile - A new instance of the Patient resource

Return Type

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

patchPatient

Remote Function

function patchPatient(string id, USCorePatientProfile patchPatient) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Patient resource

patchPatient USCorePatientProfile - An updated instance of the Patient resource

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 ()) -

exportPatientOperation

Remote Function

function exportPatientOperation(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 ()) -

getPersonById

Remote Function

function getPersonById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Person resource

Return Type

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

searchPerson

Remote Function

function searchPerson(string? _id, string? identifier) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Person ids

identifier string? (default () ) - Search parameter for identifier (token) - A person's Identifier

Return Type

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

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? identifier, string? given, string? family, string? name, string? active, string? _count) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Practitioner ids

identifier string? (default ()) - Search parameter for identifier (token) - A practitioner's Identifier

given string? (default ()) - Search parameter for given (string) - The beginning of the given name of the practitioner

family string? (default ()) - Search parameter for family (string) - The beginning of the family name of the practitioner

name string? (default ()) - Search parameter for name (string) - The beginning of the first, last or middle name of the practitioner

active string? (default ()) - Search parameter for active (token) - Whether the practitioner record is active

_count string? (default () ) - Search parameter for _count (number) - The maximum number of results to return in a page

Return Type

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

createPractitioner

Remote Function

function createPractitioner(USCorePractitionerProfile newPractitioner) returns FHIRResponse|FHIRError

Parameters

newPractitioner USCorePractitionerProfile - A new instance of the Practitioner resource

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? _id, string? patient, string? subject, string? date, string[]? _lastUpdated) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Procedure ids

patient string? (default ()) - Search parameter for patient (reference) - Search by subject - a patient

subject string? (default ()) - Search parameter for subject (reference) - Search by subject

date string? (default ()) - Search parameter for date (date) - A date parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component

_lastUpdated string[]? (default () ) - Search parameter for _lastUpdated (date) - A date or date range used to search for procedures which were last updated in that period

Return Type

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

createProcedure

Remote Function

function createProcedure(USCoreProcedureProfile newProcedure) returns FHIRResponse|FHIRError

Parameters

newProcedure USCoreProcedureProfile - A new instance of the Procedure resource

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? _id, string? target) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Provenance ids

target string? (default () ) - Search parameter for target (reference) - The resource(s) the Provenance is associated with

Return Type

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

createProvenance

Remote Function

function createProvenance(USCoreProvenance newProvenance) returns FHIRResponse|FHIRError

Parameters

newProvenance USCoreProvenance - A new instance of the Provenance resource

Return Type

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

getQuestionnaireById

Remote Function

function getQuestionnaireById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Questionnaire resource

Return Type

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

searchQuestionnaire

Remote Function

function searchQuestionnaire(string? _id) returns FHIRResponse|FHIRError

Parameters

_id string? (default () ) - Search parameter for _id (token) - A single or comma separated list of Questionnaire ids

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

searchQuestionnaireResponse

Remote Function

function searchQuestionnaireResponse(string? _id, string? patient) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of QuestionnaireResponse ids

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

Return Type

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

updateQuestionnaireResponse

Remote Function

function updateQuestionnaireResponse(QuestionnaireResponse updatedQuestionnaireResponse) returns FHIRResponse|FHIRError

Parameters

updatedQuestionnaireResponse QuestionnaireResponse - A new or updated instance of the QuestionnaireResponse 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

searchRelatedPerson

Remote Function

function searchRelatedPerson(string? _id, string? identifier, string? patient, string? _encounter, string? _relationship_level) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of RelatedPerson ids

identifier string? (default ()) - Search parameter for identifier (token) - An Identifier of the RelatedPerson

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

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

_relationship_level string? (default () ) - Search parameter for -relationship-level (token) - The resource's relationship to either the patient or encounter level

Return Type

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

createRelatedPerson

Remote Function

function createRelatedPerson(USCoreRelatedPersonProfile newRelatedPerson) returns FHIRResponse|FHIRError

Parameters

newRelatedPerson USCoreRelatedPersonProfile - A new instance of the RelatedPerson resource

Return Type

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

patchRelatedPerson

Remote Function

function patchRelatedPerson(string id, USCoreRelatedPersonProfile patchRelatedPerson) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the RelatedPerson resource

patchRelatedPerson USCoreRelatedPersonProfile - An updated instance of the RelatedPerson resource

Return Type

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

getScheduleById

Remote Function

function getScheduleById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Schedule resource

Return Type

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

searchSchedule

Remote Function

function searchSchedule(string? _id) returns FHIRResponse|FHIRError

Parameters

_id string? (default () ) - Search parameter for _id (token) - A single or comma separated list of Schedule ids

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? patient, string? subject, string? code, string[]? _lastUpdated, string? _count) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of ServiceRequest ids

patient string? (default ()) - Search parameter for patient (reference) - The patient to return ServiceRequests for

subject string? (default ()) - Search parameter for subject (reference) - Individual or Entity the service is ordered for

code string? (default ()) - Search parameter for code (token) - What is being requested/ordered

_lastUpdated string[]? (default ()) - Search parameter for _lastUpdated (date) - When the resource version last changed

_count string? (default () ) - Search parameter for _count (number) - The maximum number of results to return in a page

Return Type

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

getSlotById

Remote Function

function getSlotById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Slot resource

Return Type

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

searchSlot

Remote Function

function searchSlot(string? _id, string? 'start, string? service_type, string? schedule_actor, string? _location, string? _count) returns FHIRResponse|FHIRError

Parameters

_id string? (default ()) - Search parameter for _id (token) - A single or comma separated list of Slot ids

'start string? (default ()) - Search parameter for start (date) - A date or date range from which the slots are to be retrieved

service_type string? (default ()) - Search parameter for service-type (token) - A single or comma separated list of appointment types that can be booked into the slot

schedule_actor string? (default ()) - Search parameter for schedule.actor (reference) - A single or comma separated list of schedule actors

_location string? (default ()) - Search parameter for -location (reference) - A single or comma separated list of Location references

_count string? (default () ) - Search parameter for _count (number) - The maximum number of results to return in a page

Return Type

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

patchSlot

Remote Function

function patchSlot(string id, Slot patchSlot) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Slot resource

patchSlot Slot - An updated instance of the Slot resource

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

searchSpecimen

Remote Function

function searchSpecimen(string? _id) returns FHIRResponse|FHIRError

Parameters

_id string? (default () ) - Search parameter for _id (token) - A single or comma separated list of Specimen ids

Return Type

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

getStructureDefinitionById

Remote Function

function getStructureDefinitionById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the StructureDefinition resource

Return Type

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

Import

import ballerinax/health.clients.fhir.cerner;

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/Cerner

Cerner FHIR Connector

Dependencies

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

Cookie policy

Delete policy