Module health.clients.fhir.epic

ballerinax/health.clients.fhir.epic 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.epic.com/interconnect-fhir-oauth/api/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
Account	`read` `search-type`	-
AdverseEvent	`read` `search-type`	-
AllergyIntolerance	`create` `read` `search-type`	-
Appointment	`read` `search-type`	-
Binary	`read` `search-type`	-
BodyStructure	`create` `read` `search-type` `update`	-
CarePlan	`read` `search-type`	-
CareTeam	`read` `search-type`	-
Claim	`read` `search-type`	-
Communication	`create` `read` `search-type`	-
ConceptMap	`create` `read`	-
Condition	`create` `read` `search-type`	-
Consent	`read` `search-type`	-
Contract	`read` `search-type`	-
Coverage	`read` `search-type`	-
Device	`read` `search-type`	-
DeviceRequest	`read` `search-type`	-
DeviceUseStatement	`read` `search-type`	-
DiagnosticReport	`read` `search-type` `update`	-
DocumentReference	`create` `read` `search-type` `update`	-
Encounter	`read` `search-type`	-
Endpoint	`read` `search-type`	-
EpisodeOfCare	`read` `search-type`	-
ExplanationOfBenefit	`read` `search-type`	-
FamilyMemberHistory	`read` `search-type`	-
Flag	`read` `search-type`	-
Goal	`read` `search-type`	-
Group	`read` `search-type`	`group-export`
ImagingStudy	`read` `search-type`	-
Immunization	`read` `search-type`	-
ImmunizationRecommendation	`read` `search-type`	-
List	`read` `search-type`	-
Location	`read` `search-type`	-
Measure	`read` `search-type`	-
MeasureReport	`read` `search-type`	-
Media	`read` `search-type`	-
Medication	`read` `search-type`	-
MedicationAdministration	`read` `search-type`	-
MedicationDispense	`read` `search-type`	-
MedicationRequest	`read` `search-type`	-
NutritionOrder	`read` `search-type`	-
Observation	`create` `read` `search-type` `update`	-
Organization	`read` `search-type`	-
Patient	`create` `read` `search-type`	`summary` `match`
Practitioner	`read` `search-type`	-
PractitionerRole	`read` `search-type`	-
Procedure	`create` `read` `search-type` `update`	-
Provenance	`read`	-
Questionnaire	`read` `search-type`	-
QuestionnaireResponse	`create` `read` `search-type`	-
RelatedPerson	`read` `search-type`	-
RequestGroup	`read` `search-type`	-
ResearchStudy	`read` `search-type`	-
ResearchSubject	`read` `search-type`	-
ServiceRequest	`create` `read` `search-type` `update`	-
Specimen	`read` `search-type`	-
Substance	`read` `search-type`	-
Task	`read` `search-type` `update`	-

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>/epic.fhir.connector;
import ballerina/io;


public function main() returns error? {
    // Initialize the Epic connector client
    fhirClient:FHIRConnectorConfig epicConfig = {
        baseURL: base,
        mimeType: fhirClient:FHIR_JSON,
        authConfig: {
            tokenEndpoint: tokenEndpoint,
            clientId: clientId,
            keyFile: keyFile
        }
    };
    connector:FHIRClientConnector epicFhirclientconnector = check new (epicConfig);
    
    // Example 1: Read a patient by ID
    fhir:FHIRResponse fhirFhirresponse = check epicFhirclientconnector->getPatientById("erXuFYUfucBZaryVksYEcMg3");
    io:println("Patient Read Response: ", fhirFhirresponse.'resource);

}

Clients

health.clients.fhir.epic: FHIRClientConnector

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

getAccountById

Remote Function

function getAccountById(string id) returns FHIRResponse|FHIRError

Auto-generated operations

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

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

Return Type

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

getAdverseEventById

Remote Function

function getAdverseEventById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the AdverseEvent resource

Return Type

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

searchAdverseEvent

Remote Function

function searchAdverseEvent(string? research_subject, string? seriousness, string? study, string? subject, string? _count, string? _id, string? actuality, string? category, string? date, string? event, string? location, string? recorder, string? resultingcondition, string? severity, string? substance) returns FHIRResponse|FHIRError

Parameters

research_subject string? (default ()) - Search parameter for research-subject (reference) - Search for AdverseEvent resources for a specified research study participant

seriousness string? (default ()) - Search parameter for seriousness (token) - Refine a search for AdverseEvent resources by seriousness of the event

study string? (default ()) - Search parameter for study (reference) - Search for AdverseEvent resources for a specified study ID

subject string? (default ()) - Search parameter for subject (reference) - Search for AdverseEvent resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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

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

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

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

recorder string? (default ()) - Search parameter for recorder (reference) -

resultingcondition string? (default ()) - Search parameter for resultingcondition (reference) -

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

substance string? (default () ) - Search parameter for substance (reference) -

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

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? clinical_status, string? patient, string? _count, string? _id, string? asserter, string? category, string? code, string? criticality, string? date, string? identifier, string? last_date, string? manifestation, string? onset, string? recorder, string? route, string? severity, string? 'type, string? verification_status) returns FHIRResponse|FHIRError

Parameters

clinical_status string? (default ()) - Search parameter for clinical-status (token) - Refine a search for AllergyIntolerance resources by clinicalStatus

patient string? (default ()) - Search parameter for patient (reference) - Search for AllergyIntolerance resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

asserter string? (default ()) - Search parameter for asserter (reference) -

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

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

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

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

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

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

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

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

recorder string? (default ()) - Search parameter for recorder (reference) -

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

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

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

verification_status string? (default () ) - Search parameter for verification-status (token) -

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? date, string? identifier, string? onlyscannable, string? patient, string? service_category, string? status, string? _count, string? _id, string? actor, string? appointment_type, string? based_on, string? location, string? part_status, string? practitioner, string? reason_code, string? reason_reference, string? service_type, string? slot, string? specialty, string? supporting_info) returns FHIRResponse|FHIRError

Parameters

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

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

onlyscannable string? (default ()) - Search parameter for onlyscannable (token) - Refine a search for Appointment resources to scannable appointments only

patient string? (default ()) - Search parameter for patient (reference) - Search for Appointment resources for a specified patient ID

service_category string? (default ()) - Search parameter for service-category (token) - Search on the type of appointment

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

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

actor string? (default ()) - Search parameter for actor (reference) -

appointment_type string? (default ()) - Search parameter for appointment-type (token) -

based_on string? (default ()) - Search parameter for based-on (reference) -

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

part_status string? (default ()) - Search parameter for part-status (token) -

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

reason_code string? (default ()) - Search parameter for reason-code (token) -

reason_reference string? (default ()) - Search parameter for reason-reference (reference) -

service_type string? (default ()) - Search parameter for service-type (token) -

slot string? (default ()) - Search parameter for slot (reference) -

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

supporting_info string? (default () ) - Search parameter for supporting-info (reference) -

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

searchBinary

Remote Function

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

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

Return Type

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

createBodyStructure

Remote Function

function createBodyStructure(BodyStructure newBodyStructure) returns FHIRResponse|FHIRError

Parameters

newBodyStructure BodyStructure - A new instance of the BodyStructure resource

Return Type

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

getBodyStructureById

Remote Function

function getBodyStructureById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the BodyStructure resource

Return Type

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

searchBodyStructure

Remote Function

function searchBodyStructure(string? identifier, string? location, string? morphology, string? patient, string? subject, string? _count, string? _id) returns FHIRResponse|FHIRError

Parameters

identifier string? (default ()) - Search parameter for identifier (token) - Refine a search for BodyStructure resources by identifier

location string? (default ()) - Search parameter for location (token) - Refine a search for BodyStructure resources by location

morphology string? (default ()) - Search parameter for morphology (token) - Refine a search for BodyStructure resources by morphology

patient string? (default ()) - Search parameter for patient (reference) - Search for BodyStructure resources for a specified patient ID

subject string? (default ()) - Search parameter for subject (reference) - Search for BodyStructure resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

Return Type

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

updateBodyStructure

Remote Function

function updateBodyStructure(BodyStructure updatedBodyStructure) returns FHIRResponse|FHIRError

Parameters

updatedBodyStructure BodyStructure - A new or updated instance of the BodyStructure 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? activity_date, string? category, string? encounter, string? part_of, string? patient, string? status, string? subject, string? _count, string? _id, string? activity_code, string? activity_reference, string? based_on, string? care_team, string? condition, string? date, string? goal, string? identifier, string? instantiates_canonical, string? intent, string? performer, string? replaces) returns FHIRResponse|FHIRError

Parameters

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

category string? (default ()) - Search parameter for category (token) - Search for CarePlans of the given type

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

part_of string? (default ()) - Search parameter for part-of (reference) -

patient string? (default ()) - Search parameter for patient (reference) - Search for CarePlan resources using a specified patient ID

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

subject string? (default ()) - Search parameter for subject (reference) - Search for CarePlan resources using a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

activity_code string? (default ()) - Search parameter for activity-code (token) -

activity_reference string? (default ()) - Search parameter for activity-reference (reference) -

based_on string? (default ()) - Search parameter for based-on (reference) -

care_team string? (default ()) - Search parameter for care-team (reference) -

condition string? (default ()) - Search parameter for condition (reference) -

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

goal string? (default ()) - Search parameter for goal (reference) -

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

instantiates_canonical string? (default ()) - Search parameter for instantiates-canonical (reference) -

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

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

replaces string? (default () ) - Search parameter for replaces (reference) -

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? subject, string? _count, string? _id, string? category, string? date, string? encounter, string? identifier, string? participant) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - Search for CareTeam resources using a specified patient ID

status string? (default ()) - Search parameter for status (token) - Refine a search based on the CareTeam's status

subject string? (default ()) - Search parameter for subject (reference) - Search for CareTeam resources using a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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

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

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

participant string? (default () ) - Search parameter for participant (reference) -

Return Type

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

getClaimById

Remote Function

function getClaimById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Claim resource

Return Type

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

searchClaim

Remote Function

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

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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? based_on, string? category, string? encounter, string? part_of, string? patient, string? subject, string? _count, string? _id, string? identifier, string? instantiates_canonical, string? medium, string? received, string? recipient, string? sender, string? sent, string? status) returns FHIRResponse|FHIRError

Parameters

based_on string? (default ()) - Search parameter for based-on (reference) -

category string? (default ()) - Search parameter for category (token) - Refine a search to include only Communication resources with the given categories

encounter string? (default ()) - Search parameter for encounter (reference) - Refine a search to include Communication resources from only the encounters provided

part_of string? (default ()) - Search parameter for part-of (reference) -

patient string? (default ()) - Search parameter for patient (reference) - Search for Communication resources for a specified patient ID

subject string? (default ()) - Search parameter for subject (reference) - Search for Communication resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

instantiates_canonical string? (default ()) - Search parameter for instantiates-canonical (reference) -

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

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

recipient string? (default ()) - Search parameter for recipient (reference) -

sender string? (default ()) - Search parameter for sender (reference) -

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

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

Return Type

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

createConceptMap

Remote Function

function createConceptMap(ConceptMap newConceptMap) returns FHIRResponse|FHIRError

Parameters

newConceptMap ConceptMap - A new instance of the ConceptMap resource

Return Type

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

getConceptMapById

Remote Function

function getConceptMapById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the ConceptMap resource

Return Type

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

createCondition

Remote Function

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

Parameters

newCondition USCoreConditionEncounterDiagnosisProfile|USCoreConditionProblemsHealthConcernsProfile - A new instance of the Condition 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? abatement_date, string? category, string? clinical_status, string? code, string? encounter, string? onset_date, string? patient, string? recorded_date, string? subject, string? _count, string? _id, string? abatement_string, string? asserter, string? body_site, string? evidence, string? evidence_detail, string? identifier, string? onset_info, string? severity, string? stage, string? verification_status) returns FHIRResponse|FHIRError

Parameters

abatement_date string? (default ()) - Search parameter for abatement-date (date) - Search for Conditions with a specified abatement date

category string? (default ()) - Search parameter for category (token) - Search for Condition resources by category

clinical_status string? (default ()) - Search parameter for clinical-status (token) - Refine a search for Condition resources by clinicalStatus

code string? (default ()) - Search parameter for code (token) - Search for Conditions with a specified code

encounter string? (default ()) - Search parameter for encounter (reference) - Search for Condition resources for specific encounters

onset_date string? (default ()) - Search parameter for onset-date (date) - Search for Conditions with a specified onset date

patient string? (default ()) - Search parameter for patient (reference) - Search for Condition resources for a specified patient ID

recorded_date string? (default ()) - Search parameter for recorded-date (date) - Search for Conditions with a specified recorded date

subject string? (default ()) - Search parameter for subject (reference) - Search for Condition resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

abatement_string string? (default ()) - Search parameter for abatement-string (string) -

asserter string? (default ()) - Search parameter for asserter (reference) -

body_site string? (default ()) - Search parameter for body-site (token) -

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

evidence_detail string? (default ()) - Search parameter for evidence-detail (reference) -

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

onset_info string? (default ()) - Search parameter for onset-info (string) -

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

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

verification_status string? (default () ) - Search parameter for verification-status (token) -

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? category, string? patient, string? status, string? subject, string? _count, string? _id, string? action, string? actor, string? consentor, string? data, string? date, string? identifier, string? organization, string? period, string? purpose, string? scope, string? security_label, string? source_reference) returns FHIRResponse|FHIRError

Parameters

category string? (default ()) - Search parameter for category (token) - Search for Consent resources by category

patient string? (default ()) - Search parameter for patient (reference) - Search for Consent resources for a specified patient ID

status string? (default ()) - Search parameter for status (token) - Search for Consent resources by status

subject string? (default ()) - Search parameter for subject (reference) - Search for Consent resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

actor string? (default ()) - Search parameter for actor (reference) -

consentor string? (default ()) - Search parameter for consentor (reference) -

data string? (default ()) - Search parameter for data (reference) -

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

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

organization string? (default ()) - Search parameter for organization (reference) -

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

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

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

security_label string? (default ()) - Search parameter for security-label (token) -

source_reference string? (default () ) - Search parameter for source-reference (reference) -

Return Type

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

getContractById

Remote Function

function getContractById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Contract resource

Return Type

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

searchContract

Remote Function

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

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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? beneficiary, string? patient, string? _count, string? _id, string? class_type, string? class_value, string? dependent, string? identifier, string? payor, string? policy_holder, string? status, string? subscriber, string? 'type) returns FHIRResponse|FHIRError

Parameters

beneficiary string? (default ()) - Search parameter for beneficiary (reference) - Search for Coverage resource for a specific patient ID

patient string? (default ()) - Search parameter for patient (reference) - Search for Coverage resource for a specific patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

class_type string? (default ()) - Search parameter for class-type (token) -

class_value string? (default ()) - Search parameter for class-value (string) -

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

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

payor string? (default ()) - Search parameter for payor (reference) -

policy_holder string? (default ()) - Search parameter for policy-holder (reference) -

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

subscriber string? (default ()) - Search parameter for subscriber (reference) -

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

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? device_name, string? manufacturer, string? model, string? patient, string? udi_carrier, string? udi_di, string? _count, string? _id, string? identifier, string? location, string? organization, string? status, string? 'type) returns FHIRResponse|FHIRError

Parameters

device_name string? (default ()) - Search parameter for device-name (string) - A string that will match the Device

manufacturer string? (default ()) - Search parameter for manufacturer (string) - Manufacturer of the device

model string? (default ()) - Search parameter for model (string) - Model number of the device

patient string? (default ()) - Search parameter for patient (reference) - The patient in whom this device is implanted

udi_carrier string? (default ()) - Search parameter for udi-carrier (string) - The UDI barcode string - matches static UDI

udi_di string? (default ()) - Search parameter for udi-di (string) - The UDI device identifier (DI)

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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

organization string? (default ()) - Search parameter for organization (reference) -

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

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

Return Type

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

getDeviceRequestById

Remote Function

function getDeviceRequestById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the DeviceRequest resource

Return Type

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

searchDeviceRequest

Remote Function

function searchDeviceRequest(string? patient, string? status, string? _count, string? _id, string? authored_on, string? based_on, string? code, string? device, string? encounter, string? event_date, string? group_identifier, string? identifier, string? instantiates_canonical, string? insurance, string? intent, string? performer, string? prior_request, string? requester, string? subject) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - Search for DeviceRequest resource for a specified patient ID

status string? (default ()) - Search parameter for status (token) - Search for a DeviceRequest based on a device request status

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

authored_on string? (default ()) - Search parameter for authored-on (date) -

based_on string? (default ()) - Search parameter for based-on (reference) -

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

device string? (default ()) - Search parameter for device (reference) -

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

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

group_identifier string? (default ()) - Search parameter for group-identifier (token) -

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

instantiates_canonical string? (default ()) - Search parameter for instantiates-canonical (reference) -

insurance string? (default ()) - Search parameter for insurance (reference) -

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

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

prior_request string? (default ()) - Search parameter for prior-request (reference) -

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

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

Return Type

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

getDeviceUseStatementById

Remote Function

function getDeviceUseStatementById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the DeviceUseStatement resource

Return Type

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

searchDeviceUseStatement

Remote Function

function searchDeviceUseStatement(string? patient, string? subject, string? _count, string? _id, string? device, string? identifier) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - Search for DeviceUseStatement resources for a specified patient ID

subject string? (default ()) - Search parameter for subject (reference) - Search for DeviceUseStatement resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

device string? (default ()) - Search parameter for device (reference) -

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

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? category, string? code, string? date, string? identifier, string? patient, string? subject, string? _count, string? _id, string? based_on, string? conclusion, string? encounter, string? issued, string? media, string? performer, string? result, string? results_interpreter, string? specimen, string? status) returns FHIRResponse|FHIRError

Parameters

category string? (default ()) - Search parameter for category (token) - Refine a search for DiagnosticReport resources by category

code string? (default ()) - Search parameter for code (token) - Refine a search for DiagnosticReport resources by code

date string? (default ()) - Search parameter for date (date) - Refine a search for DiagnosticReport resources by specifying a date or date range that a DiagnosticReport was resulted or recorded

identifier string? (default ()) - Search parameter for identifier (token) - Refine search by specifying an identifier, such as the internal order ID or the accession number

patient string? (default ()) - Search parameter for patient (reference) - Search for DiagnosticReport resources for a specified patient ID

subject string? (default ()) - Search parameter for subject (reference) - Search for DiagnosticReport resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

based_on string? (default ()) - Search parameter for based-on (reference) -

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

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

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

media string? (default ()) - Search parameter for media (reference) -

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

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

results_interpreter string? (default ()) - Search parameter for results-interpreter (reference) -

specimen string? (default ()) - Search parameter for specimen (reference) -

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

Return Type

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

updateDiagnosticReport

Remote Function

function updateDiagnosticReport(USCoreDiagnosticReportProfileLaboratoryReporting|USCoreDiagnosticReportProfileNoteExchange updatedDiagnosticReport) returns FHIRResponse|FHIRError

Parameters

updatedDiagnosticReport USCoreDiagnosticReportProfileLaboratoryReporting|USCoreDiagnosticReportProfileNoteExchange - A new or updated instance of the DiagnosticReport resource

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

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? author, string? category, string? date, string? docstatus, string? encounter, string? patient, string? period, string? status, string? subject, string? 'type, string? _count, string? _id, string? _lastupdated, string? authenticator, string? contenttype, string? custodian, string? description, string? event, string? facility, string? format, string? identifier, string? language, string? related, string? relatesto, string? relation, string? security_label, string? setting) returns FHIRResponse|FHIRError

Parameters

author string? (default ()) - Search parameter for author (reference) - Further refine a search for a given set of DocumentReferences on a patient by specifying a Reference that corresponds to the author of the document

category string? (default ()) - Search parameter for category (token) - Refine a search for DocumentReference resources by category

date string? (default ()) - Search parameter for date (date) - Further refine a search for a given set of DocumentReferences on a patient by specifying a date or date range in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]]) that corresponds to the document creation time

docstatus string? (default ()) - Search parameter for docstatus (token) - Further refine a search for a given set of DocumentReferences on a patient by specifying a docStatus

encounter string? (default ()) - Search parameter for encounter (reference) - Search for DocumentReference resources for a specific internal or external encounter

patient string? (default ()) - Search parameter for patient (reference) - Search for DocumentReference resources for a specified patient ID

period string? (default ()) - Search parameter for period (date) - Further refine a search for a given set of DocumentReferences on a patient by specifying a date or date range in ISO format (YYYY[-MM[-DD]]) that corresponds to the time of the service that is being documented

status string? (default ()) - Search parameter for status (token) - Further refine a search for a given set of DocumentReferences on a patient by specifying a status of the document

subject string? (default ()) - Search parameter for subject (reference) - Search for DocumentReference resources for a specified patient ID

'type string? (default ()) - Search parameter for type (token) - Further refine a search for a given set of DocumentReferences on a patient by specifying a type code to return only documents of that type

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

_lastupdated string? (default ()) - Search parameter for _lastupdated (date) - Further refine a search by the date list in meta

authenticator string? (default ()) - Search parameter for authenticator (reference) -

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

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

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

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

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

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

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

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

related string? (default ()) - Search parameter for related (reference) -

relatesto string? (default ()) - Search parameter for relatesto (reference) -

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

security_label string? (default ()) - Search parameter for security-label (token) -

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

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

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? 'class, string? date, string? identifier, string? onlyscannable, string? patient, string? subject, string? _count, string? _id, string? account, string? appointment, string? based_on, string? diagnosis, string? episode_of_care, string? location, string? location_period, string? part_of, string? participant, string? participant_type, string? practitioner, string? reason_code, string? reason_reference, string? service_provider, string? special_arrangement, string? status, string? 'type) returns FHIRResponse|FHIRError

Parameters

'class string? (default ()) - Search parameter for class (token) - Refine a search for Encounter resources by class

date string? (default ()) - Search parameter for date (date) - Refine a search for Encounter resources by date

identifier string? (default ()) - Search parameter for identifier (token) - Search for Encounter resources by encounter identifier in the format <code system>|<code>

onlyscannable string? (default ()) - Search parameter for onlyscannable (token) - Refine a search for Encounter resources to scannable encounters only

patient string? (default ()) - Search parameter for patient (reference) - Search for Encounter resources for a specified patient ID

subject string? (default ()) - Search parameter for subject (reference) - Search for Encounter resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

account string? (default ()) - Search parameter for account (reference) -

appointment string? (default ()) - Search parameter for appointment (reference) -

based_on string? (default ()) - Search parameter for based-on (reference) -

diagnosis string? (default ()) - Search parameter for diagnosis (reference) -

episode_of_care string? (default ()) - Search parameter for episode-of-care (reference) -

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

location_period string? (default ()) - Search parameter for location-period (date) -

part_of string? (default ()) - Search parameter for part-of (reference) -

participant string? (default ()) - Search parameter for participant (reference) -

participant_type string? (default ()) - Search parameter for participant-type (token) -

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

reason_code string? (default ()) - Search parameter for reason-code (token) -

reason_reference string? (default ()) - Search parameter for reason-reference (reference) -

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

special_arrangement string? (default ()) - Search parameter for special-arrangement (token) -

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

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

Return Type

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

getEndpointById

Remote Function

function getEndpointById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Endpoint resource

Return Type

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

searchEndpoint

Remote Function

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

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

Return Type

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

getEpisodeOfCareById

Remote Function

function getEpisodeOfCareById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the EpisodeOfCare resource

Return Type

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

searchEpisodeOfCare

Remote Function

function searchEpisodeOfCare(string? patient, string? status, string? 'type, string? _count, string? _id, string? care_manager, string? condition, string? date, string? identifier, string? incoming_referral, string? organization) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - Search for EpisodeOfCare resources for a specified patient ID

status string? (default ()) - Search parameter for status (token) - Refine a search for EpisodeOfCare resources by status

'type string? (default ()) - Search parameter for type (token) - Refine a search for EpisodeOfCare resources by type

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

care_manager string? (default ()) - Search parameter for care-manager (reference) -

condition string? (default ()) - Search parameter for condition (reference) -

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

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

incoming_referral string? (default ()) - Search parameter for incoming-referral (reference) -

organization string? (default () ) - Search parameter for organization (reference) -

Return Type

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

getExplanationOfBenefitById

Remote Function

function getExplanationOfBenefitById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the ExplanationOfBenefit resource

Return Type

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

searchExplanationOfBenefit

Remote Function

function searchExplanationOfBenefit(string? created, string? patient, string? use, string? _count, string? _id, string? care_team, string? claim, string? coverage, string? detail_udi, string? disposition, string? encounter, string? enterer, string? facility, string? identifier, string? item_udi, string? payee, string? procedure_udi, string? provider, string? status, string? subdetail_udi) returns FHIRResponse|FHIRError

Parameters

created string? (default ()) - Search parameter for created (date) - Refine a search for ExplanationOfBenefit resources by creation date for the claim

patient string? (default ()) - Search parameter for patient (reference) - Search for ExplanationOfBenefit resources for a specified patient ID

use string? (default ()) - Search parameter for use (token) - Refine a search for ExplanationOfBenefit by use

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

care_team string? (default ()) - Search parameter for care-team (reference) -

claim string? (default ()) - Search parameter for claim (reference) -

coverage string? (default ()) - Search parameter for coverage (reference) -

detail_udi string? (default ()) - Search parameter for detail-udi (reference) -

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

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

enterer string? (default ()) - Search parameter for enterer (reference) -

facility string? (default ()) - Search parameter for facility (reference) -

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

item_udi string? (default ()) - Search parameter for item-udi (reference) -

payee string? (default ()) - Search parameter for payee (reference) -

procedure_udi string? (default ()) - Search parameter for procedure-udi (reference) -

provider string? (default ()) - Search parameter for provider (reference) -

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

subdetail_udi string? (default () ) - Search parameter for subdetail-udi (reference) -

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? patient, string? _count, string? _id, string? code, string? date, string? identifier, string? instantiates_canonical, string? relationship, string? sex, string? status) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - Required: the patient whose family history you'd like to search

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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

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

instantiates_canonical string? (default ()) - Search parameter for instantiates-canonical (reference) -

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

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

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

Return Type

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

getFlagById

Remote Function

function getFlagById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Flag resource

Return Type

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

searchFlag

Remote Function

function searchFlag(string? category, string? encounter, string? patient, string? status, string? subject, string? _count, string? _id, string? author, string? date, string? identifier) returns FHIRResponse|FHIRError

Parameters

category string? (default ()) - Search parameter for category (token) - Refine a search for Flag resources by category

encounter string? (default ()) - Search parameter for encounter (reference) - Refine a search for Flag resources by encounter

patient string? (default ()) - Search parameter for patient (reference) - Search for Flag resources for a specified patient ID

status string? (default ()) - Search parameter for status (token) - Refine a search for Flag resources by status

subject string? (default ()) - Search parameter for subject (reference) - Search for Flag resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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

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

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? category, string? lifecycle_status, string? patient, string? start_date, string? subject, string? _count, string? _id, string? achievement_status, string? identifier, string? target_date) returns FHIRResponse|FHIRError

Parameters

category string? (default ()) - Search parameter for category (token) - Refines a search by Goal category

lifecycle_status string? (default ()) - Search parameter for lifecycle-status (token) - Refines a search based on Goal lifecycle status

patient string? (default ()) - Search parameter for patient (reference) - Search for Patient resources for a specific patient ID

start_date string? (default ()) - Search parameter for start-date (date) - Refines a search based on Goal start date

subject string? (default ()) - Search parameter for subject (reference) - Search for Patient resources for a specific patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

achievement_status string? (default ()) - Search parameter for achievement-status (token) -

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

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

Return Type

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

getGroupById

Remote Function

function getGroupById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Group resource

Return Type

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

searchGroup

Remote Function

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

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

Return Type

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

groupExportGroupOperation

Remote Function

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

getImagingStudyById

Remote Function

function getImagingStudyById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the ImagingStudy resource

Return Type

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

searchImagingStudy

Remote Function

function searchImagingStudy(string? identifier, string? patient, string? subject, string? _count, string? _id, string? basedon, string? bodysite, string? dicom_class, string? encounter, string? endpoint, string? instance, string? interpreter, string? modality, string? performer, string? reason, string? referrer, string? series, string? started, string? status) returns FHIRResponse|FHIRError

Parameters

identifier string? (default ()) - Search parameter for identifier (token) - Search for ImagingStudy resources by a study's identifier

patient string? (default ()) - Search parameter for patient (reference) - Search for ImagingStudy resources for a specified patient ID

subject string? (default ()) - Search parameter for subject (reference) - Search for ImagingStudy resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

basedon string? (default ()) - Search parameter for basedon (reference) -

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

dicom_class string? (default ()) - Search parameter for dicom-class (token) -

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

endpoint string? (default ()) - Search parameter for endpoint (reference) -

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

interpreter string? (default ()) - Search parameter for interpreter (reference) -

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

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

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

referrer string? (default ()) - Search parameter for referrer (reference) -

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

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

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

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? date, string? patient, string? status, string? _count, string? _id, string? identifier, string? location, string? lot_number, string? manufacturer, string? performer, string? reaction, string? reaction_date, string? reason_code, string? reason_reference, string? series, string? status_reason, string? target_disease, string? vaccine_code) returns FHIRResponse|FHIRError

Parameters

date string? (default ()) - Search parameter for date (date) - Refine a search for Immunization resources by vaccine administration date

patient string? (default ()) - Search parameter for patient (reference) - Search for Immunization resources for a specified patient ID

status string? (default ()) - Search parameter for status (token) - Refine a search for Immunization resources by status

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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

lot_number string? (default ()) - Search parameter for lot-number (string) -

manufacturer string? (default ()) - Search parameter for manufacturer (reference) -

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

reaction string? (default ()) - Search parameter for reaction (reference) -

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

reason_code string? (default ()) - Search parameter for reason-code (token) -

reason_reference string? (default ()) - Search parameter for reason-reference (reference) -

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

status_reason string? (default ()) - Search parameter for status-reason (token) -

target_disease string? (default ()) - Search parameter for target-disease (token) -

vaccine_code string? (default () ) - Search parameter for vaccine-code (token) -

Return Type

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

getImmunizationRecommendationById

Remote Function

function getImmunizationRecommendationById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the ImmunizationRecommendation resource

Return Type

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

searchImmunizationRecommendation

Remote Function

function searchImmunizationRecommendation(string? patient, string? _count, string? _id, string? date, string? identifier, string? information, string? status, string? support, string? target_disease, string? vaccine_type) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - The FHIR id of a patient whose immunization recommendations you'd like to obtain

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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

information string? (default ()) - Search parameter for information (reference) -

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

support string? (default ()) - Search parameter for support (reference) -

target_disease string? (default ()) - Search parameter for target-disease (token) -

vaccine_type string? (default () ) - Search parameter for vaccine-type (token) -

Return Type

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

getListById

Remote Function

function getListById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the List resource

Return Type

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

searchList

Remote Function

function searchList(string? code, string? encounter, string? identifier, string? patient, string? subject, string? _count, string? _id, string? date, string? empty_reason, string? item, string? notes, string? 'source, string? status, string? title) returns FHIRResponse|FHIRError

Parameters

code string? (default ()) - Search parameter for code (token) - Refine a search for List resources by list type

encounter string? (default ()) - Search parameter for encounter (reference) - Refine a search for List resources by encounter

identifier string? (default ()) - Search parameter for identifier (token) - Refine a search for List resource by internal identifier

patient string? (default ()) - Search parameter for patient (reference) - Refine a search for List resources by patient

subject string? (default ()) - Search parameter for subject (reference) - Refine a search for List resources by patient

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

empty_reason string? (default ()) - Search parameter for empty-reason (token) -

item string? (default ()) - Search parameter for item (reference) -

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

'source string? (default ()) - Search parameter for source (reference) -

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

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

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? 'type, string? _count, string? _id, string? address, string? address_city, string? address_country, string? address_postalcode, string? address_state, string? address_use, string? endpoint, string? identifier, string? name, string? operational_status, string? organization, string? partof, string? status) returns FHIRResponse|FHIRError

Parameters

'type string? (default ()) - Search parameter for type (token) - Search for Location resources with a specified location type

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

address_city string? (default ()) - Search parameter for address-city (string) -

address_country string? (default ()) - Search parameter for address-country (string) -

address_postalcode string? (default ()) - Search parameter for address-postalcode (string) -

address_state string? (default ()) - Search parameter for address-state (string) -

address_use string? (default ()) - Search parameter for address-use (token) -

endpoint string? (default ()) - Search parameter for endpoint (reference) -

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

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

operational_status string? (default ()) - Search parameter for operational-status (token) -

organization string? (default ()) - Search parameter for organization (reference) -

partof string? (default ()) - Search parameter for partof (reference) -

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

Return Type

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

getMeasureById

Remote Function

function getMeasureById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Measure resource

Return Type

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

searchMeasure

Remote Function

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

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

Return Type

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

getMeasureReportById

Remote Function

function getMeasureReportById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the MeasureReport resource

Return Type

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

searchMeasureReport

Remote Function

function searchMeasureReport(string? epic_group_id, string? patient, string? subject, string? _count, string? _id, string? _lastupdated, string? date, string? evaluated_resource, string? identifier, string? measure, string? period, string? reporter, string? status) returns FHIRResponse|FHIRError

Parameters

epic_group_id string? (default ()) - Search parameter for epic-group-id (string) -

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

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

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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

evaluated_resource string? (default ()) - Search parameter for evaluated-resource (reference) -

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

measure string? (default ()) - Search parameter for measure (reference) -

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

reporter string? (default ()) - Search parameter for reporter (reference) -

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

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

searchMedia

Remote Function

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

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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? context, string? effective_time, string? patient, string? performer, string? request, string? status, string? subject, string? _count, string? _id, string? code, string? device, string? identifier, string? medication, string? reason_given, string? reason_not_given) returns FHIRResponse|FHIRError

Parameters

context string? (default ()) - Search parameter for context (reference) - Refine a search for MedicationAdministration resources with one or more linked reference

effective_time string? (default ()) - Search parameter for effective-time (date) - Refine a search for MedicationAdministration resources for a given patient by specifying a date or a range of dates for the administration

patient string? (default ()) - Search parameter for patient (reference) - Search for MedicationAdministration resources for a specified patient ID

performer string? (default ()) - Search parameter for performer (reference) - Refine a search for MedicationAdministration resources by one or more associated reference

request string? (default ()) - Search parameter for request (reference) - Refine a search for MedicationAdministration resources by associated reference

status string? (default ()) - Search parameter for status (token) - Refine a search for MedicationAdministration resources with one or more statuses

subject string? (default ()) - Search parameter for subject (reference) - Search for MedicationAdministration resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

device string? (default ()) - Search parameter for device (reference) -

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

medication string? (default ()) - Search parameter for medication (reference) -

reason_given string? (default ()) - Search parameter for reason-given (token) -

reason_not_given string? (default () ) - Search parameter for reason-not-given (token) -

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? category, string? patient, string? subject, string? _count, string? _id, string? code, string? context, string? destination, string? identifier, string? medication, string? performer, string? prescription, string? receiver, string? responsibleparty, string? status, string? 'type, string? whenhandedover, string? whenprepared) returns FHIRResponse|FHIRError

Parameters

category string? (default ()) - Search parameter for category (token) - Refine a search for MedicationDispense resources by category

patient string? (default ()) - Search parameter for patient (reference) - Search for MedicationDispense resources for a specified patient ID

subject string? (default ()) - Search parameter for subject (reference) - Search for MedicationDispense resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

context string? (default ()) - Search parameter for context (reference) -

destination string? (default ()) - Search parameter for destination (reference) -

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

medication string? (default ()) - Search parameter for medication (reference) -

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

prescription string? (default ()) - Search parameter for prescription (reference) -

receiver string? (default ()) - Search parameter for receiver (reference) -

responsibleparty string? (default ()) - Search parameter for responsibleparty (reference) -

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

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

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

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

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? category, string? date, string? intent, string? patient, string? status, string? subject, string? _count, string? _id, string? authoredon, string? code, string? encounter, string? identifier, string? intended_dispenser, string? intended_performer, string? intended_performertype, string? medication, string? priority, string? requester) returns FHIRResponse|FHIRError

Parameters

category string? (default ()) - Search parameter for category (token) - Refine a search for MedicationRequest resources by category

date string? (default ()) - Search parameter for date (date) - Refine a search for MedicationRequest resources for a given patient by specifying a date or a range of dates for when the medication was activated

intent string? (default ()) - Search parameter for intent (token) - Refine a search for MedicationRequest resources by one or more intents

patient string? (default ()) - Search parameter for patient (reference) - Search for MedicationRequest resources for a specified patient ID

status string? (default ()) - Search parameter for status (token) - Refine a search for MedicationRequest resources by one or more statuses

subject string? (default ()) - Search parameter for subject (reference) - Search for MedicationRequest resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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

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

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

intended_dispenser string? (default ()) - Search parameter for intended-dispenser (reference) -

intended_performer string? (default ()) - Search parameter for intended-performer (reference) -

intended_performertype string? (default ()) - Search parameter for intended-performertype (token) -

medication string? (default ()) - Search parameter for medication (reference) -

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

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

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? patient, string? _count, string? _id, string? additive, string? datetime, string? encounter, string? formula, string? identifier, string? instantiates_canonical, string? oraldiet, string? provider, string? status, string? supplement) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - Search for NutritionOrder resources for the specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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

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

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

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

instantiates_canonical string? (default ()) - Search parameter for instantiates-canonical (reference) -

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

provider string? (default ()) - Search parameter for provider (reference) -

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

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

Return Type

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

createObservation

Remote Function

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

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? based_on, string? category, string? code, string? date, string? focus, string? issued, string? patient, string? subject, string? _count, string? _id, string? combo_code, string? combo_data_absent_reason, string? combo_value_concept, string? component_code, string? component_data_absent_reason, string? component_value_concept, string? data_absent_reason, string? derived_from, string? device, string? encounter, string? has_member, string? identifier, string? method, string? part_of, string? performer, string? specimen, string? status, string? value_concept, string? value_date, string? value_string) returns FHIRResponse|FHIRError

Parameters

based_on string? (default ()) - Search parameter for based-on (reference) - Refine a search for Observation resources by specifying a Reference associated with the Observation

category string? (default ()) - Search parameter for category (token) - Refine a search for Observation resources by category or SNOMED code

code string? (default ()) - Search parameter for code (token) - Refine a search for Observation resources by LOINC code, SNOMED code, flowsheet row IDs, or SmartData Identifiers

date string? (default ()) - Search parameter for date (date) - Refine a search for Observation resources by specifying a date or date range that an Observation was resulted or recorded

focus string? (default ()) - Search parameter for focus (reference) - Refine a search for Observation resources by specifying a Reference associated with the Observation

issued string? (default ()) - Search parameter for issued (date) - Refine a search for Observation resources by specifying a date or date range that an Observation was made available

patient string? (default ()) - Search parameter for patient (reference) - Search for Observation resources for a specified patient ID

subject string? (default ()) - Search parameter for subject (reference) - Search for Observation resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

combo_code string? (default ()) - Search parameter for combo-code (token) -

combo_data_absent_reason string? (default ()) - Search parameter for combo-data-absent-reason (token) -

combo_value_concept string? (default ()) - Search parameter for combo-value-concept (token) -

component_code string? (default ()) - Search parameter for component-code (token) -

component_data_absent_reason string? (default ()) - Search parameter for component-data-absent-reason (token) -

component_value_concept string? (default ()) - Search parameter for component-value-concept (token) -

data_absent_reason string? (default ()) - Search parameter for data-absent-reason (token) -

derived_from string? (default ()) - Search parameter for derived-from (reference) -

device string? (default ()) - Search parameter for device (reference) -

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

has_member string? (default ()) - Search parameter for has-member (reference) -

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

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

part_of string? (default ()) - Search parameter for part-of (reference) -

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

specimen string? (default ()) - Search parameter for specimen (reference) -

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

value_concept string? (default ()) - Search parameter for value-concept (token) -

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

value_string string? (default () ) - Search parameter for value-string (string) -

Return Type

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

updateObservation

Remote Function

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

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

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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? address, string? address_city, string? address_postalcode, string? address_state, string? birthdate, string? doc_type, string? family, string? gender, string? given, string? identifier, string? legal_sex, string? name, string? own_name, string? own_prefix, string? partner_name, string? partner_prefix, string? telecom, string? _count, string? _id, string? active, string? address_country, string? address_use, string? death_date, string? email, string? general_practitioner, string? language, string? link, string? organization, string? phone, string? phonetic) returns FHIRResponse|FHIRError

Parameters

address string? (default ()) - Search parameter for address (string) - Search for Patient resources using an address string

address_city string? (default ()) - Search parameter for address-city (string) - Search for Patient resources using the city for a patient's home address

address_postalcode string? (default ()) - Search parameter for address-postalcode (string) - Search for Patient resources using the postal code for a patient's home address

address_state string? (default ()) - Search parameter for address-state (string) - Search for Patient resources using the state for a patient's home address

birthdate string? (default ()) - Search parameter for birthdate (date) - Search for Patient resources using a date of birth in ISO format (YYYY-MM-DD)

doc_type string? (default ()) - Search parameter for doc-type (token) - Search for Patient resources using Singapore document type

family string? (default ()) - Search parameter for family (string) - Search for Patient resources by family (last) name

gender string? (default ()) - Search parameter for gender (token) - Search for Patient resources using the following gender codes: female, male, other, or unknown

given string? (default ()) - Search parameter for given (string) - Search for Patient resources by given (first) name

identifier string? (default ()) - Search parameter for identifier (token) - Search for Patient resources by a patient's identifier

legal_sex string? (default ()) - Search parameter for legal-sex (token) - Search for Patient resources using the following gender codes: female, male, nonbinary, x, other, or unknown

name string? (default ()) - Search parameter for name (string) - Search for Patient resources by a patient's name

own_name string? (default ()) - Search parameter for own-name (string) - Search for Patient resources by patient's own last name, usually used in non-US names

own_prefix string? (default ()) - Search parameter for own-prefix (string) - Search for Patient resources by patient's own last name prefix, usually used in non-US names

partner_name string? (default ()) - Search parameter for partner-name (string) - Search for Patient resources by patient's spouse's last name, usually used in non-US names

partner_prefix string? (default ()) - Search parameter for partner-prefix (string) - Search for Patient resources by patient's spouse's last name prefix, usually used in non-US names

telecom string? (default ()) - Search parameter for telecom (token) - Search for Patient resources using a patient's home phone number, cell phone number, or email address

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

address_country string? (default ()) - Search parameter for address-country (string) -

address_use string? (default ()) - Search parameter for address-use (token) -

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

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

general_practitioner string? (default ()) - Search parameter for general-practitioner (reference) -

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

link string? (default ()) - Search parameter for link (reference) -

organization string? (default ()) - Search parameter for organization (reference) -

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

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

Return Type

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

summaryPatientOperation

Remote Function

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

matchPatientOperation

Remote Function

function matchPatientOperation(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? address, string? address_city, string? address_postalcode, string? address_state, string? family, string? given, string? identifier, string? name, string? _count, string? _id, string? active, string? address_country, string? address_use, string? communication, string? email, string? gender, string? phone, string? phonetic, string? telecom) returns FHIRResponse|FHIRError

Parameters

address string? (default ()) - Search parameter for address (string) - Any part of an address (street, city, etc

address_city string? (default ()) - Search parameter for address-city (string) - The city where a practitioner can be visited

address_postalcode string? (default ()) - Search parameter for address-postalcode (string) - The zip code where a practitioner can be found

address_state string? (default ()) - Search parameter for address-state (string) - The state where a practitioner can be found

family string? (default ()) - Search parameter for family (string) - A practitioner's family (last) name

given string? (default ()) - Search parameter for given (string) - A practitioner's given (first) name

identifier string? (default ()) - Search parameter for identifier (token) - A practitioner's identifier in the format <code system>|<code>

name string? (default ()) - Search parameter for name (string) - Any part of a practitioner's name

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

address_country string? (default ()) - Search parameter for address-country (string) -

address_use string? (default ()) - Search parameter for address-use (token) -

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

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

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

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

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

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

Return Type

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

getPractitionerRoleById

Remote Function

function getPractitionerRoleById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the PractitionerRole resource

Return Type

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

searchPractitionerRole

Remote Function

function searchPractitionerRole(string? email, string? identifier, string? location, string? organization, string? phone, string? practitioner, string? role, string? specialty, string? telecom, string? _count, string? _id, string? active, string? date, string? endpoint, string? 'service) returns FHIRResponse|FHIRError

Parameters

email string? (default ()) - Search parameter for email (token) - Refine a search for a PractitionerRole by entering a valid email address

identifier string? (default ()) - Search parameter for identifier (token) - Search for PractitionerRoles using identifiers

location string? (default ()) - Search parameter for location (reference) - Search for PractitionerRoles using a Location ID

organization string? (default ()) - Search parameter for organization (reference) - Search for PractitionerRoles using an Organization ID

phone string? (default ()) - Search parameter for phone (token) - Refine a search for a PractitionerRole by entering a valid phone number

practitioner string? (default ()) - Search parameter for practitioner (reference) - Search for PractitionerRoles for a specified Practitioner ID

role string? (default ()) - Search parameter for role (token) - Refine a search for a PractitionerRole by entering a valid role

specialty string? (default ()) - Search parameter for specialty (token) - Search for PractitionerRoles for a given specialty

telecom string? (default ()) - Search parameter for telecom (token) - Refine a search for a PractitionerRole for a specific telecom

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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

endpoint string? (default ()) - Search parameter for endpoint (reference) -

'service string? (default () ) - Search parameter for service (reference) -

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

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? category, string? code, string? date, string? identifier, string? patient, string? subject, string? _count, string? _id, string? based_on, string? encounter, string? instantiates_canonical, string? location, string? part_of, string? performer, string? reason_code, string? reason_reference, string? status) returns FHIRResponse|FHIRError

Parameters

category string? (default ()) - Search parameter for category (token) - Refine a search for Procedure resources by category

code string? (default ()) - Search parameter for code (token) - Refine a search for Procedure based on code

date string? (default ()) - Search parameter for date (date) - Refine a search for Procedure resources by specifying a date or date range that a Procedure was resulted

identifier string? (default ()) - Search parameter for identifier (token) - Refine a search for Procedure by identifier

patient string? (default ()) - Search parameter for patient (reference) - Search for Procedure resources for a specified patient ID

subject string? (default ()) - Search parameter for subject (reference) - Search for Procedure resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

based_on string? (default ()) - Search parameter for based-on (reference) -

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

instantiates_canonical string? (default ()) - Search parameter for instantiates-canonical (reference) -

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

part_of string? (default ()) - Search parameter for part-of (reference) -

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

reason_code string? (default ()) - Search parameter for reason-code (token) -

reason_reference string? (default ()) - Search parameter for reason-reference (reference) -

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

Return Type

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

updateProcedure

Remote Function

function updateProcedure(USCoreProcedureProfile updatedProcedure) returns FHIRResponse|FHIRError

Parameters

updatedProcedure USCoreProcedureProfile - A new or updated 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

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

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

Return Type

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

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

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? encounter, string? patient, string? subject, string? _count, string? _id, string? author, string? authored, string? based_on, string? identifier, string? part_of, string? questionnaire, string? 'source, string? status) returns FHIRResponse|FHIRError

Parameters

encounter string? (default ()) - Search parameter for encounter (reference) - Search for QuestionnaireResponses by encounter

patient string? (default ()) - Search parameter for patient (reference) - Search for QuestionnaireResponses for a specified patient

subject string? (default ()) - Search parameter for subject (reference) - Search for QuestionnaireResponses for a specified patient or research subject

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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

based_on string? (default ()) - Search parameter for based-on (reference) -

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

part_of string? (default ()) - Search parameter for part-of (reference) -

questionnaire string? (default ()) - Search parameter for questionnaire (reference) -

'source string? (default ()) - Search parameter for source (reference) -

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

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

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

Return Type

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

getRequestGroupById

Remote Function

function getRequestGroupById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the RequestGroup resource

Return Type

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

searchRequestGroup

Remote Function

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

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

Return Type

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

getResearchStudyById

Remote Function

function getResearchStudyById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the ResearchStudy resource

Return Type

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

searchResearchStudy

Remote Function

function searchResearchStudy(string? identifier, string? status, string? _count, string? _id, string? category, string? date, string? focus, string? keyword, string? location, string? partof, string? principalinvestigator, string? protocol, string? site, string? sponsor, string? title) returns FHIRResponse|FHIRError

Parameters

identifier string? (default ()) - Search parameter for identifier (token) - Search for the ResearchStudy resource for a specified study code or NCT number

status string? (default ()) - Search parameter for status (token) - Search for the ResearchStudy resource for a specified status

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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

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

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

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

partof string? (default ()) - Search parameter for partof (reference) -

principalinvestigator string? (default ()) - Search parameter for principalinvestigator (reference) -

protocol string? (default ()) - Search parameter for protocol (reference) -

site string? (default ()) - Search parameter for site (reference) -

sponsor string? (default ()) - Search parameter for sponsor (reference) -

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

Return Type

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

getResearchSubjectById

Remote Function

function getResearchSubjectById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the ResearchSubject resource

Return Type

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

searchResearchSubject

Remote Function

function searchResearchSubject(string? patient, string? status, string? study, string? _count, string? _id, string? date, string? identifier) returns FHIRResponse|FHIRError

Parameters

patient string? (default ()) - Search parameter for patient (reference) - Search for the ResearchSubject resources related to a specified patient

status string? (default ()) - Search parameter for status (token) - Search for the ResearchSubject resources for a specified status

study string? (default ()) - Search parameter for study (reference) - Search for the ResearchSubject resources related to a specified study

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

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

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

Return Type

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

createServiceRequest

Remote Function

function createServiceRequest(USCoreServiceRequestProfile newServiceRequest) returns FHIRResponse|FHIRError

Parameters

newServiceRequest USCoreServiceRequestProfile - A new instance of the ServiceRequest resource

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? authored, string? category, string? code, string? encounter, string? identifier, string? onlyscannable, string? patient, string? requester, string? status, string? subject, string? _count, string? _id, string? based_on, string? body_site, string? instantiates_canonical, string? intent, string? occurrence, string? performer, string? performer_type, string? priority, string? replaces, string? requisition, string? specimen) returns FHIRResponse|FHIRError

Parameters

authored string? (default ()) - Search parameter for authored (date) - Refine a search for ServiceRequests for a particular date and time

category string? (default ()) - Search parameter for category (token) - Refine a search for ServiceRequests of a particular category

code string? (default ()) - Search parameter for code (token) - Refine a search for ServiceRequest based on code

encounter string? (default ()) - Search parameter for encounter (reference) - Search for ServiceRequest resources for specific encounters

identifier string? (default ()) - Search parameter for identifier (token) - Refine a search for ServiceRequest by identifier

onlyscannable string? (default ()) - Search parameter for onlyscannable (token) - Refine a search for ServiceRequest resources to scannable only

patient string? (default ()) - Search parameter for patient (reference) - Search ServiceRequest resources for a specified patient ID

requester string? (default ()) - Search parameter for requester (reference) - Refine a search for ServiceRequest resources by individual making the request

status string? (default ()) - Search parameter for status (token) - Refine a search for ServiceRequest resources by status

subject string? (default ()) - Search parameter for subject (reference) - Search ServiceRequest resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

based_on string? (default ()) - Search parameter for based-on (reference) -

body_site string? (default ()) - Search parameter for body-site (token) -

instantiates_canonical string? (default ()) - Search parameter for instantiates-canonical (reference) -

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

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

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

performer_type string? (default ()) - Search parameter for performer-type (token) -

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

replaces string? (default ()) - Search parameter for replaces (reference) -

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

specimen string? (default () ) - Search parameter for specimen (reference) -

Return Type

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

updateServiceRequest

Remote Function

function updateServiceRequest(USCoreServiceRequestProfile updatedServiceRequest) returns FHIRResponse|FHIRError

Parameters

updatedServiceRequest USCoreServiceRequestProfile - A new or updated instance of the ServiceRequest 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? _count, string? _id) returns FHIRResponse|FHIRError

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

Return Type

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

getSubstanceById

Remote Function

function getSubstanceById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Substance resource

Return Type

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

searchSubstance

Remote Function

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

Parameters

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default () ) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

Return Type

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

getTaskById

Remote Function

function getTaskById(string id) returns FHIRResponse|FHIRError

Parameters

id string - The logical ID of the Task resource

Return Type

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

searchTask

Remote Function

function searchTask(string? code, string? encounter, string? focus, string? patient, string? status, string? subject, string? _count, string? _id, string? authored_on, string? based_on, string? business_status, string? group_identifier, string? identifier, string? intent, string? modified, string? owner, string? part_of, string? performer, string? period, string? priority, string? requester) returns FHIRResponse|FHIRError

Parameters

code string? (default ()) - Search parameter for code (token) - Specify community-resource for CRRN tasks, episode-checklist for Episode Checklist tasks

encounter string? (default ()) - Search parameter for encounter (reference) - Further refine the search for a task by specifying the encounter associated with the task

focus string? (default ()) - Search parameter for focus (reference) -

patient string? (default ()) - Search parameter for patient (reference) - Search for Task resources for a specified patient ID

status string? (default ()) - Search parameter for status (token) - Restrict the search for tasks based on task status

subject string? (default ()) - Search parameter for subject (reference) - Search for Task resources for a specified patient ID

_count string? (default ()) - Search parameter for _count (number) - Number of results per page

_id string? (default ()) - Search parameter for _id (token) - FHIR resource IDs for the desired resources

authored_on string? (default ()) - Search parameter for authored-on (date) -

based_on string? (default ()) - Search parameter for based-on (reference) -

business_status string? (default ()) - Search parameter for business-status (token) -

group_identifier string? (default ()) - Search parameter for group-identifier (token) -

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

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

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

owner string? (default ()) - Search parameter for owner (reference) -

part_of string? (default ()) - Search parameter for part-of (reference) -

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

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

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

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

Return Type

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

updateTask

Remote Function

function updateTask(Task updatedTask) returns FHIRResponse|FHIRError

Parameters

updatedTask Task - A new or updated instance of the Task resource

Return Type

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

Import

import ballerinax/health.clients.fhir.epic;

Other versions

1.0.0

Metadata

Released date: 21 days 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

Healthcare

FHIR

epic

epic-fhir-connector

Dependencies

ballerinax/health.clients.fhir/3.0.0 ballerinax/health.fhir.r4.international401/4.0.0 ballerinax/health.fhir.r4.uscore610/3.0.0

Cookie policy

Delete policy