The Oracle Health (Cerner) connector lets your AI agent act in each user's Oracle Health (Cerner) account. Each user signs in to Oracle Health (Cerner) once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 82 tools.
- Tools
- 82
- What they doRead · write · destructive
- 66 · 16 · 066 read16 write0 destructive
- Users sign in with
- SMART on FHIR
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Oracle Health (Cerner) connection
In AgentKit > Connections, create an Oracle Health (Cerner) connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Console steps with screenshots
Oracle Health (Cerner Millennium) connections use SMART on FHIR and act as the signed-in clinician through Oracle Health’s provider persona. Each Oracle Health tenant has its own tenant ID, and that ID is part of the authorization endpoint, the token endpoint and the FHIR base URL. Each connection carries those values plus the client ID and secret of your Oracle Health app.
-
Create the connection and copy the redirect URI
In the Scalekit dashboard, go to AgentKit > Connections > Create Connection, find Oracle Health and click Create. Copy the Redirect URI.
-
Register a provider app with Oracle Health
In the Oracle Health code console, register a confidential app for the provider persona that uses user-context scopes, and note its client ID and client secret:
- Add the redirect URI you copied.
- Request refresh tokens (
offline_access). - Choose SMART v1 scopes, and enable the user-level scope for every resource your agent reads or writes. Oracle Health grants only the resources enabled on the app.
For a production tenant, get the customer’s tenant ID. The customer also files a service request with Oracle Health to provision your app for their tenant.
-
Find the tenant’s endpoints
The FHIR R4 base for a tenant is
https://<fhir-host>/r4/<tenant-id>. Open<FHIR base>/.well-known/smart-configurationand copyauthorization_endpointandtoken_endpoint. Both include the tenant ID, and the authorization endpoint ends in/personas/provider/authorize. -
Enter the values on the connection
Back on the Oracle Health connection, enter:
- Client ID and Client Secret: from your Oracle Health app.
- Authorization Endpoint and Token Endpoint: from
.well-known/smart-configuration. - Audience (aud): the full FHIR base URL, including the tenant ID.
- FHIR Server Domain: the FHIR base without
https://, including its path, such as<fhir-host>/r4/<tenant-id>.
Select
openid,fhirUserandoffline_access, plus the SMART v1 resource scopes your agent needs, such asuser/Patient.readanduser/Condition.write. Leave SMART v2 scopes (such asuser/Patient.rs) unselected: if a request includes any v2 scope, Oracle Health returns a token that can’t read any data. Click Save.To test against Oracle Health’s sandbox tenant, use these values:
Field Sandbox value Authorization Endpoint https://authorization.cerner.com/tenants/ec2458f2-1e24-41c8-b71b-0e701af7583d/protocols/oauth2/profiles/smart-v1/personas/provider/authorizeToken Endpoint https://authorization.cerner.com/tenants/ec2458f2-1e24-41c8-b71b-0e701af7583d/hosts/fhir-ehr-code.cerner.com/protocols/oauth2/profiles/smart-v1/tokenAudience (aud) https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583dFHIR Server Domain fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d
-
Tools
Pass the exact name toexecute_tooloraclehealth_allergy_intolerance_readGet one allergy or intolerance from Oracle Health by its FHIR logical ID.Read-onlyGet Allergy Intolerance
Get one allergy or intolerance from Oracle Health by its FHIR logical ID. Returns the FHIR AllergyIntolerance resource: substance code, clinical and verification status, criticality, reactions, and notes, plus meta.versionId. Use oraclehealth_allergy_intolerance_read when you have the ID. Use oraclehealth_allergy_intolerance_search to find allergies and intolerances for a patient, optionally by clinical status or last update.
Inputs
allergy_intolerance_idstringrequired- FHIR logical ID of the allergy or intolerance, from a search result or a reference such as AllergyIntolerance/<id>. Example: 12345
oraclehealth_allergy_intolerance_searchSearch allergies and intolerances in Oracle Health for a patient, optionally by clinical status or last update.Read-onlySearch Allergy Intolerances
Search allergies and intolerances in Oracle Health for a patient, optionally by clinical status or last update. Returns a FHIR Bundle of AllergyIntolerance resources (substance code, clinical and verification status, criticality, reactions, and notes) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_allergy_intolerance_search to find or list records. Use oraclehealth_allergy_intolerance_read to fetch one known ID.
Inputs
_idstring- Logical ID of the allergy record to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
_lastUpdatedarray- Filter allergy records by when they were last updated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z"]
clinical_statusstring- Clinical status to filter by: active, inactive, or resolved. Example: activeone of
activeinactiveresolved patientstring- FHIR logical ID of the patient whose allergies to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
oraclehealth_appointment_readGet one appointment from Oracle Health by its FHIR logical ID.Read-onlyGet Appointment
Get one appointment from Oracle Health by its FHIR logical ID. Returns the FHIR Appointment resource: status, service type, start and end, slot, participants (patient, practitioner, location), reason, and comment, plus meta.versionId. Use oraclehealth_appointment_read when you have the ID. Use oraclehealth_appointment_search to find appointments for one patient, practitioner, or location in a date range.
Inputs
appointment_idstringrequired- FHIR logical ID of the appointment, from a search result or a reference such as Appointment/<id>. Example: 12345
oraclehealth_appointment_searchSearch appointments in Oracle Health for one patient, practitioner, or location in a date range.Read-onlySearch Appointments
Search appointments in Oracle Health for one patient, practitioner, or location in a date range. Returns a FHIR Bundle of Appointment resources (status, service type, start and end, slot, participants (patient, practitioner, location), reason, and comment) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_appointment_search to find or list records. Use oraclehealth_appointment_read to fetch one known ID.
Inputs
_countinteger- Maximum number of results per page. Example: 20
_idstring- Logical ID of the appointment to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
datearray- Appointment start/end range (excludes proposed appointments). Required with patient, practitioner, or location unless date_or_requested_period is set; values need a time and offset. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z", "lt2024-02-01T00:00:00Z"]
date_or_requested_periodarray- Like date, but also returns proposed appointments whose requested period falls in the range. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z", "lt2024-02-01T00:00:00Z"]
locationstring- FHIR logical ID of the location; several may be comma-separated. Use exactly one of patient, practitioner, or location, together with a date range. Example: 34567
patientstring- FHIR logical ID of the patient; several may be comma-separated. Use exactly one of patient, practitioner, or location, together with date or date_or_requested_period. Example: 12345
practitionerstring- FHIR logical ID of the practitioner; several may be comma-separated. Use exactly one of patient, practitioner, or location, together with a date range. Example: 23456
statusstring- Appointment status; several may be comma-separated: proposed, pending, booked, arrived, fulfilled, cancelled, noshow, entered-in-error, checked-in, waitlist. Example: booked
oraclehealth_binary_autogen_ccdGenerate a Continuity of Care Document (CCD) for a patient, optionally for one encounter or a date range.Read-onlyGenerate Patient CCD
Generate a Continuity of Care Document (CCD) for a patient, optionally for one encounter or a date range. Returns a FHIR Binary resource whose base64 data is the C-CDA XML document. Use it to get a full clinical summary in one call. Use the individual search tools (conditions, medications, allergies, results) for structured data.
Inputs
patientstringrequired- FHIR logical ID of the patient the CCD is about. Example: 12345
encounterstring- FHIR logical ID of an encounter to limit the CCD to. Example: 67890
endstring- End of the date range, as a date-time with time component and no prefix. Omit to include records up to now. Example: 2024-12-31T23:59:59Z
startstring- Start of the date range, as a date-time with time component and no prefix. Omit to include everything before end. Example: 2024-01-01T00:00:00Z
oraclehealth_binary_readGet the content of a clinical document, report, or message from Oracle Health by its Binary ID.Read-onlyGet Binary Document
Get the content of a clinical document, report, or message from Oracle Health by its Binary ID. Returns a FHIR Binary resource with contentType and base64-encoded data (for example the text, HTML, RTF, or PDF of a note). Use it to read the attachment that a document reference, diagnostic report (presentedForm), or communication payload links to. Use oraclehealth_document_reference_search to find the documents first. Needs the Binary read scope plus read access to the referring DocumentReference, DiagnosticReport, or Communication.
Inputs
binary_idstringrequired- FHIR logical ID of the Binary, taken from the attachment URL (the part after Binary/) in a DocumentReference, DiagnosticReport, or Communication. Example: TR-12345
oraclehealth_care_plan_readGet one care plan from Oracle Health by its FHIR logical ID.Read-onlyGet Care Plan
Get one care plan from Oracle Health by its FHIR logical ID. Returns the FHIR CarePlan resource: plan category, status, intent, period, and narrative description (activity details are not returned by Oracle Health), plus meta.versionId. Use oraclehealth_care_plan_read when you have the ID. Use oraclehealth_care_plan_search to find care plans for a patient (category assess-plan).
Inputs
care_plan_idstringrequired- FHIR logical ID of the care plan, from a search result or a reference such as CarePlan/<id>. Example: 12345
oraclehealth_care_plan_searchSearch care plans in Oracle Health for a patient (category assess-plan).Read-onlySearch Care Plans
Search care plans in Oracle Health for a patient (category assess-plan). Returns a FHIR Bundle of CarePlan resources (plan category, status, intent, period, and narrative description (activity details are not returned by Oracle Health)) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_care_plan_search to find or list records. Use oraclehealth_care_plan_read to fetch one known ID.
Inputs
_countinteger- Maximum number of results per page. Example: 20
_idstring- Logical ID of the care plan to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
categorystring- Care plan category. Oracle Health supports only assess-plan, and it is required with patient. Example: assess-planone of
assess-plan datearray- Filter by the period the plan covers. Must have two values: one ge and one le, with the same precision. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z", "lt2024-02-01T00:00:00Z"]
patientstring- FHIR logical ID of the patient whose care plans to return, without the 'Patient/' prefix. Required unless _id is given; send with category. Find it with oraclehealth_patient_search. Example: 12345
oraclehealth_care_team_readGet one care team from Oracle Health by its FHIR logical ID.Read-onlyGet Care Team
Get one care team from Oracle Health by its FHIR logical ID. Returns the FHIR CareTeam resource: team category, status, participants with their roles, and the patient or encounter it serves, plus meta.versionId. Use oraclehealth_care_team_read when you have the ID. Use oraclehealth_care_team_search to find care teams for a patient or encounter.
Inputs
care_team_idstringrequired- FHIR logical ID of the care team, from a search result or a reference such as CareTeam/<id>. Example: 12345
oraclehealth_care_team_searchSearch care teams in Oracle Health for a patient or encounter.Read-onlySearch Care Teams
Search care teams in Oracle Health for a patient or encounter. Returns a FHIR Bundle of CareTeam resources (team category, status, participants with their roles, and the patient or encounter it serves) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_care_team_search to find or list records. Use oraclehealth_care_team_read to fetch one known ID.
Inputs
_idstring- Logical ID of the care team to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
categorystring- Care team category: longitudinal or encounter. Use only with patient. Example: longitudinalone of
longitudinalencounter encounterstring- FHIR logical ID of an encounter to return its care team. Required unless _id or patient is given; can't be combined with category or status. Example: 67890
patientstring- FHIR logical ID of the patient whose care teams to return, without the 'Patient/' prefix. Required unless _id or encounter is given. Find it with oraclehealth_patient_search. Example: 12345
statusstring- Care team status to filter by, for example active. Use with patient. Example: active
oraclehealth_communication_readGet one message (Communication) from Oracle Health by its FHIR logical ID.Read-onlyGet Communication
Get one message (Communication) from Oracle Health by its FHIR logical ID. Returns the FHIR Communication resource: category, status, sender, recipients, topic, sent and received times, and a payload link whose text is fetched with oraclehealth_binary_read, plus meta.versionId. Use oraclehealth_communication_read when you have the ID. Use oraclehealth_communication_search to find inbox messages for a recipient by category, received date, and email status.
Inputs
communication_idstringrequired- FHIR logical ID of the message (Communication), from a search result or a reference such as Communication/<id>. Example: 12345
oraclehealth_communication_searchSearch inbox messages in Oracle Health for a recipient by category, received date, and email status.Read-onlySearch Communications
Search inbox messages in Oracle Health for a recipient by category, received date, and email status. Returns a FHIR Bundle of Communication resources (category, status, sender, recipients, topic, sent and received times, and a payload link whose text is fetched with oraclehealth_binary_read) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_communication_search to find or list records. Use oraclehealth_communication_read to fetch one known ID.
Inputs
_idstring- Logical ID of the communication to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
categorystring- Communication category as system|code. Required with recipient, received, and email_status unless _id is given. Example: http://terminology.hl7.org/CodeSystem/communication-category|notification
email_statusstring- Email status as system|code. Required with category, recipient, and received unless _id is given. Example: http://hl7.org/fhir/task-status|in-progress
receivedarray- Received date range; values need a time component. One value uses ge; two values use ge and le. Required with category, recipient, and email_status unless _id is given. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z", "lt2024-02-01T00:00:00Z"]
recipientstring- Recipient practitioner or group, for example Practitioner/23456. Required with category, received, and email_status unless _id is given. Example: Practitioner/23456
oraclehealth_condition_readGet one condition (problem or diagnosis) from Oracle Health by its FHIR logical ID.Read-onlyGet Condition
Get one condition (problem or diagnosis) from Oracle Health by its FHIR logical ID. Returns the FHIR Condition resource: condition code, category (problem list or encounter diagnosis), clinical and verification status, onset, and notes, plus meta.versionId. Use oraclehealth_condition_read when you have the ID. Use oraclehealth_condition_search to find conditions for a patient, optionally by category, clinical status, encounter, or last update.
Inputs
condition_idstringrequired- FHIR logical ID of the condition (problem or diagnosis), from a search result or a reference such as Condition/<id>. Example: 12345
oraclehealth_condition_searchSearch conditions in Oracle Health for a patient, optionally by category, clinical status, encounter, or last update.Read-onlySearch Conditions
Search conditions in Oracle Health for a patient, optionally by category, clinical status, encounter, or last update. Returns a FHIR Bundle of Condition resources (condition code, category (problem list or encounter diagnosis), clinical and verification status, onset, and notes) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_condition_search to find or list records. Use oraclehealth_condition_read to fetch one known ID.
Inputs
_idstring- Logical ID of the condition to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
_lastUpdatedarray- Filter conditions by when they were last updated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z"]
categorystring- Condition category: problem-list-item, encounter-diagnosis, health-concern, or sdoh. Example: problem-list-itemone of
problem-list-itemencounter-diagnosishealth-concernsdoh clinical_statusstring- Clinical status to filter by, for example active, inactive, or resolved. Example: active
encounterstring- FHIR logical ID of an encounter. Returns that encounter's encounter-diagnosis conditions plus all of the patient's problem-list items. Example: 67890
patientstring- FHIR logical ID of the patient whose conditions to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
oraclehealth_coverage_readGet one insurance coverage from Oracle Health by its FHIR logical ID.Read-onlyGet Coverage
Get one insurance coverage from Oracle Health by its FHIR logical ID. Returns the FHIR Coverage resource: payor, plan, subscriber, beneficiary relationship, period, and order of coverage, plus meta.versionId. Use oraclehealth_coverage_read when you have the ID. Use oraclehealth_coverage_search to find insurance coverages for a patient or encounter.
Inputs
coverage_idstringrequired- FHIR logical ID of the insurance coverage, from a search result or a reference such as Coverage/<id>. Example: 12345
oraclehealth_coverage_searchSearch insurance coverages in Oracle Health for a patient or encounter.Read-onlySearch Coverages
Search insurance coverages in Oracle Health for a patient or encounter. Returns a FHIR Bundle of Coverage resources (payor, plan, subscriber, beneficiary relationship, period, and order of coverage) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_coverage_search to find or list records. Use oraclehealth_coverage_read to fetch one known ID.
Inputs
_idstring- Logical ID of the coverage to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
encounterstring- FHIR logical ID of an encounter to return its encounter-level coverages. Example: 67890
patientstring- Patient whose coverages to return, as Patient/<id> (the vendor's documented form). Required unless _id or encounter is given. Example: Patient/12345
oraclehealth_device_readGet one implantable device from Oracle Health by its FHIR logical ID.Read-onlyGet Device
Get one implantable device from Oracle Health by its FHIR logical ID. Returns the FHIR Device resource: device type, UDI, status, manufacturer details, and the patient, plus meta.versionId. Use oraclehealth_device_read when you have the ID. Use oraclehealth_device_search to find devices for a patient.
Inputs
device_idstringrequired- FHIR logical ID of the implantable device, from a search result or a reference such as Device/<id>. Example: 12345
oraclehealth_device_searchSearch devices in Oracle Health for a patient.Read-onlySearch Devices
Search devices in Oracle Health for a patient. Returns a FHIR Bundle of Device resources (device type, UDI, status, manufacturer details, and the patient) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_device_search to find or list records. Use oraclehealth_device_read to fetch one known ID.
Inputs
_idstring- Logical ID of the device to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
patientstring- FHIR logical ID of the patient whose devices to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
oraclehealth_diagnostic_report_readGet one diagnostic report from Oracle Health by its FHIR logical ID.Read-onlyGet Diagnostic Report
Get one diagnostic report from Oracle Health by its FHIR logical ID. Returns the FHIR DiagnosticReport resource: report code, category, status, effective time, result references, conclusion, and links to the report document (presentedForm), plus meta.versionId. Use oraclehealth_diagnostic_report_read when you have the ID. Use oraclehealth_diagnostic_report_search to find diagnostic reports for a patient by category, code, encounter, or date.
Inputs
diagnostic_report_idstringrequired- FHIR logical ID of the diagnostic report, from a search result or a reference such as DiagnosticReport/<id>. Example: 12345
oraclehealth_diagnostic_report_searchSearch diagnostic reports in Oracle Health for a patient by category, code, encounter, or date.Read-onlySearch Diagnostic Reports
Search diagnostic reports in Oracle Health for a patient by category, code, encounter, or date. Returns a FHIR Bundle of DiagnosticReport resources (report code, category, status, effective time, result references, conclusion, and links to the report document (presentedForm)) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_diagnostic_report_search to find or list records. Use oraclehealth_diagnostic_report_read to fetch one known ID.
Inputs
_countinteger- Maximum number of results per page. Default 10, maximum 100. Example: 20
_idstring- Logical ID of the diagnostic report to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
_lastUpdatedarray- Filter diagnostic reports by when they were last updated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z"]
categorystring- Report category as system|code. Example: http://terminology.hl7.org/CodeSystem/v2-0074|LAB
codestring- Report code as system|code. Example: http://loinc.org|24323-8
datearray- Filter by the report's effective date-time. Can't be combined with _lastUpdated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z", "lt2024-02-01T00:00:00Z"]
encounterstring- FHIR logical ID of the encounter to filter diagnostic reports by, without the 'Encounter/' prefix. Several IDs may be comma-separated. Example: 67890
patientstring- FHIR logical ID of the patient whose diagnostic reports to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
oraclehealth_document_reference_docrefRun the $docref operation to list a patient's documents of given types in an optional date range.Read-onlyFind Patient Documents ($docref)
Run the $docref operation to list a patient's documents of given types in an optional date range. Returns a FHIR Bundle of DocumentReference resources; fetch each document's content with oraclehealth_binary_read. Use it for a type-driven lookup such as the patient's summary of care (CCD). Use oraclehealth_document_reference_search for general filtering by encounter, category, or date.
Inputs
patientstringrequired- FHIR logical ID of the patient. Example: 12345
typestringrequired- Document type(s) as system|code; both are required, several may be comma-separated. Example: http://loinc.org|34133-9 (summary of episode note / CCD)
endstring- End of the date range, as a date-time with time component and no prefix. Example: 2024-12-31T23:59:59Z
startstring- Start of the date range, as a date-time with time component and no prefix. Example: 2024-01-01T00:00:00Z
oraclehealth_document_reference_readGet one clinical document reference from Oracle Health by its FHIR logical ID.Read-onlyGet Document Reference
Get one clinical document reference from Oracle Health by its FHIR logical ID. Returns the FHIR DocumentReference resource: document type, category, status, author, encounter context, and attachment links whose content is fetched with oraclehealth_binary_read, plus meta.versionId. Use oraclehealth_document_reference_read when you have the ID. Use oraclehealth_document_reference_search to find clinical documents for a patient by type, category, encounter, or date.
Inputs
document_reference_idstringrequired- FHIR logical ID of the clinical document reference, from a search result or a reference such as DocumentReference/<id>. Example: 12345
oraclehealth_document_reference_searchSearch clinical documents in Oracle Health for a patient by type, category, encounter, or date.Read-onlySearch Document References
Search clinical documents in Oracle Health for a patient by type, category, encounter, or date. Returns a FHIR Bundle of DocumentReference resources (document type, category, status, author, encounter context, and attachment links whose content is fetched with oraclehealth_binary_read) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_document_reference_search to find or list records. Use oraclehealth_document_reference_read to fetch one known ID.
Inputs
_countinteger- Maximum number of results per page. Default 10, maximum 100. Example: 20
_idstring- Logical ID of the document reference to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
_lastUpdatedarray- Filter documents by when they were last updated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z"]
categorystring- Document category as system|code. Example: http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category|clinical-note
datearray- Filter by when the document reference was created. Use only one of date, period, or _lastUpdated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z", "lt2024-02-01T00:00:00Z"]
encounterstring- FHIR logical ID of the encounter to filter documents by, without the 'Encounter/' prefix. Several IDs may be comma-separated. Example: 67890
patientstring- FHIR logical ID of the patient whose documents to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
periodarray- Filter by the time of service documented. Must have two values: one ge and one lt. Use only one of date, period, or _lastUpdated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z", "lt2024-02-01T00:00:00Z"]
typestring- Document type as system|code; several may be comma-separated. Example: http://loinc.org|11506-3
oraclehealth_encounter_readGet one encounter (visit or admission) from Oracle Health by its FHIR logical ID.Read-onlyGet Encounter
Get one encounter (visit or admission) from Oracle Health by its FHIR logical ID. Returns the FHIR Encounter resource: encounter class, type, status, period, location, participants, and reason, plus meta.versionId. Use oraclehealth_encounter_read when you have the ID. Use oraclehealth_encounter_search to find encounters for a patient, account, or identifier, optionally by status and date.
Inputs
encounter_idstringrequired- FHIR logical ID of the encounter (visit or admission), from a search result or a reference such as Encounter/<id>. Example: 12345
oraclehealth_encounter_searchSearch encounters in Oracle Health for a patient, account, or identifier, optionally by status and date.Read-onlySearch Encounters
Search encounters in Oracle Health for a patient, account, or identifier, optionally by status and date. Returns a FHIR Bundle of Encounter resources (encounter class, type, status, period, location, participants, and reason) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_encounter_search to find or list records. Use oraclehealth_encounter_read to fetch one known ID.
Inputs
_countinteger- Maximum number of results per page. Example: 20
_idstring- Logical ID of the encounter to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
_lastUpdatedarray- Filter encounters by when they were last updated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z"]
accountstring- Financial account ID to return encounters for (provider persona only). Example: F000000
datearray- Filter by encounter period. Each value must use ge, gt, le, or lt. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z", "lt2024-02-01T00:00:00Z"]
identifierstring- Encounter identifier as system|value, or the value alone (for example a financial number). Example: urn:oid:1.2.3.4|000000
patientstring- FHIR logical ID of the patient whose encounters to return. Required unless _id, account, or identifier is given. Oracle Health's docs say _count and status should be sent with patient. Find the ID with oraclehealth_patient_search. Example: 12345
statusstring- Encounter status: planned, in-progress, finished, or cancelled. Example: finishedone of
plannedin-progressfinishedcancelled
oraclehealth_family_member_history_readGet one family member history from Oracle Health by its FHIR logical ID.Read-onlyGet Family Member History
Get one family member history from Oracle Health by its FHIR logical ID. Returns the FHIR FamilyMemberHistory resource: the relative's relationship, sex, conditions with onset, and status, plus meta.versionId. Use oraclehealth_family_member_history_read when you have the ID. Use oraclehealth_family_member_history_search to find family member histories for a patient.
Inputs
family_member_history_idstringrequired- FHIR logical ID of the family member history, from a search result or a reference such as FamilyMemberHistory/<id>. Example: 12345
oraclehealth_family_member_history_searchSearch family member histories in Oracle Health for a patient.Read-onlySearch Family Member Histories
Search family member histories in Oracle Health for a patient. Returns a FHIR Bundle of FamilyMemberHistory resources (the relative's relationship, sex, conditions with onset, and status) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_family_member_history_search to find or list records. Use oraclehealth_family_member_history_read to fetch one known ID.
Inputs
_idstring- Logical ID of the family member history to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
patientstring- FHIR logical ID of the patient whose family member histories to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
statusstring- Record status to filter by (patient searches only), for example completed. Example: completed
oraclehealth_goal_readGet one goal from Oracle Health by its FHIR logical ID.Read-onlyGet Goal
Get one goal from Oracle Health by its FHIR logical ID. Returns the FHIR Goal resource: goal description, lifecycle status, targets with due dates, and the patient, plus meta.versionId. Use oraclehealth_goal_read when you have the ID. Use oraclehealth_goal_search to find goals for a patient, optionally by target date.
Inputs
goal_idstringrequired- FHIR logical ID of the goal, from a search result or a reference such as Goal/<id>. Example: 12345
oraclehealth_goal_searchSearch goals in Oracle Health for a patient, optionally by target date.Read-onlySearch Goals
Search goals in Oracle Health for a patient, optionally by target date. Returns a FHIR Bundle of Goal resources (goal description, lifecycle status, targets with due dates, and the patient) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_goal_search to find or list records. Use oraclehealth_goal_read to fetch one known ID.
Inputs
_idstring- Logical ID of the goal to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
patientstring- FHIR logical ID of the patient whose goals to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
target_datearray- Filter by goal target date. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z", "lt2024-02-01T00:00:00Z"]
oraclehealth_immunization_readGet one immunization from Oracle Health by its FHIR logical ID.Read-onlyGet Immunization
Get one immunization from Oracle Health by its FHIR logical ID. Returns the FHIR Immunization resource: vaccine code, status, occurrence date, lot number, site, route, dose, and performer, plus meta.versionId. Use oraclehealth_immunization_read when you have the ID. Use oraclehealth_immunization_search to find immunizations for a patient, optionally by date or target disease.
Inputs
immunization_idstringrequired- FHIR logical ID of the immunization, from a search result or a reference such as Immunization/<id>. Example: 12345
oraclehealth_immunization_searchSearch immunizations in Oracle Health for a patient, optionally by date or target disease.Read-onlySearch Immunizations
Search immunizations in Oracle Health for a patient, optionally by date or target disease. Returns a FHIR Bundle of Immunization resources (vaccine code, status, occurrence date, lot number, site, route, dose, and performer) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_immunization_search to find or list records. Use oraclehealth_immunization_read to fetch one known ID.
Inputs
_idstring- Logical ID of the immunization to return. Several IDs may be comma-separated. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
_lastUpdatedstring- Return immunizations updated after this date or date-time. One value only, with the gt or ge prefix. Example: ge2024-01-01T00:00:00Z
datearray- Filter by administration date; a single value must use le or ge. Can't be combined with _lastUpdated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z", "lt2024-02-01T00:00:00Z"]
patientstring- FHIR logical ID of the patient whose immunizations to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
target_diseasestring- Disease the dose protects against, as system|code (standard codes only). Example: http://hl7.org/fhir/sid/cvx|213
oraclehealth_location_readGet one location from Oracle Health by its FHIR logical ID.Read-onlyGet Location
Get one location from Oracle Health by its FHIR logical ID. Returns the FHIR Location resource: name, status, type, physical type, address, and managing organization, plus meta.versionId. Use oraclehealth_location_read when you have the ID. Use oraclehealth_location_search to find locations by physical type, identifier, address, or name.
Inputs
location_idstringrequired- FHIR logical ID of the location, from a search result or a reference such as Location/<id>. Example: 12345
oraclehealth_location_searchSearch locations in Oracle Health by physical type, identifier, address, or name.Read-onlySearch Locations
Search locations in Oracle Health by physical type, identifier, address, or name. Returns a FHIR Bundle of Location resources (name, status, type, physical type, address, and managing organization) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_location_search to find or list records. Use oraclehealth_location_read to fetch one known ID.
Inputs
_idstring- Logical ID of the location to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
addressstring- Part of the location's address. Example: 100 Example St
address_citystring- City in the address; also send address_state or address_postalcode. Example: Exampleville
address_postalcodestring- Postal code in the address. Example: 00000
address_statestring- State in the address. Example: MO
identifierstring- Location identifier. Example: 000000
namestring- Part of the location's name or alias; send with physical_type, identifier, or an address filter. Example: Main
organizationstring- FHIR logical ID of the managing organization; send with physical_type, identifier, or an address filter. Example: 45678
physical_typestring- Physical type as system|code (standard codes only). Required unless _id is given. Example: http://terminology.hl7.org/CodeSystem/location-physical-type|ro
oraclehealth_media_readGet one media item from Oracle Health by its FHIR logical ID.Read-onlyGet Media
Get one media item from Oracle Health by its FHIR logical ID. Returns the FHIR Media resource: media type, content attachment, and the report it belongs to; read it from the link in a diagnostic report. Use oraclehealth_media_read with an ID taken from a reference in another resource; Oracle Health offers no useful search for Media.
Inputs
media_idstringrequired- FHIR logical ID of the media item, from a reference such as Media/<id>. Example: 12345
oraclehealth_medication_administration_readGet one medication administration from Oracle Health by its FHIR logical ID.Read-onlyGet Medication Administration
Get one medication administration from Oracle Health by its FHIR logical ID. Returns the FHIR MedicationAdministration resource: medication, status, effective time, dose, route, performer, and the related order, plus meta.versionId. Use oraclehealth_medication_administration_read when you have the ID. Use oraclehealth_medication_administration_search to find medication administrations for a patient, optionally by status, performer, or administration time.
Inputs
medication_administration_idstringrequired- FHIR logical ID of the medication administration, from a search result or a reference such as MedicationAdministration/<id>. Example: 12345
oraclehealth_medication_administration_searchSearch medication administrations in Oracle Health for a patient, optionally by status, performer, or administration time.Read-onlySearch Medication Administrations
Search medication administrations in Oracle Health for a patient, optionally by status, performer, or administration time. Returns a FHIR Bundle of MedicationAdministration resources (medication, status, effective time, dose, route, performer, and the related order) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_medication_administration_search to find or list records. Use oraclehealth_medication_administration_read to fetch one known ID.
Inputs
_idstring- Logical ID of the medication administration to return. Several IDs may be comma-separated. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
effective_timearray- Filter by administration time; each value needs a time component. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z", "lt2024-02-01T00:00:00Z"]
patientstring- FHIR logical ID of the patient whose medication administrations to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
performerstring- FHIR logical ID of the practitioner who gave the medication; several may be comma-separated. Example: 23456
statusstring- Status; several may be comma-separated: completed, not-done, entered-in-error. Example: completed
oraclehealth_medication_dispense_readGet one medication dispense from Oracle Health by its FHIR logical ID.Read-onlyGet Medication Dispense
Get one medication dispense from Oracle Health by its FHIR logical ID. Returns the FHIR MedicationDispense resource: medication, quantity, days supply, handover time, status, and the authorizing prescription, plus meta.versionId. Use oraclehealth_medication_dispense_read when you have the ID. Use oraclehealth_medication_dispense_search to find medication dispenses for a patient, optionally by handover date.
Inputs
medication_dispense_idstringrequired- FHIR logical ID of the medication dispense, from a search result or a reference such as MedicationDispense/<id>. Example: 12345
oraclehealth_medication_dispense_searchSearch medication dispenses in Oracle Health for a patient, optionally by handover date.Read-onlySearch Medication Dispenses
Search medication dispenses in Oracle Health for a patient, optionally by handover date. Returns a FHIR Bundle of MedicationDispense resources (medication, quantity, days supply, handover time, status, and the authorizing prescription) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_medication_dispense_search to find or list records. Use oraclehealth_medication_dispense_read to fetch one known ID.
Inputs
_countinteger- Maximum number of results per page. Example: 20
_idstring- Logical ID of the medication dispense to return. Several IDs may be comma-separated. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
_lastUpdatedstring- Return dispenses updated on or after this date-time. One value with ge or gt. Takes priority over date. Example: ge2024-01-01T00:00:00Z
datestring- Return dispenses handed over on or after this date-time. One value with the ge or gt prefix. Example: ge2024-01-01T00:00:00Z
patientstring- FHIR logical ID of the patient whose medication dispenses to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
oraclehealth_medication_request_readGet one medication request (order or reported medication) from Oracle Health by its FHIR logical ID.Read-onlyGet Medication Request
Get one medication request (order or reported medication) from Oracle Health by its FHIR logical ID. Returns the FHIR MedicationRequest resource: medication code, status, intent, dosage instructions, requester, and dispense details, plus meta.versionId. Use oraclehealth_medication_request_read when you have the ID. Use oraclehealth_medication_request_search to find medication requests for a patient, optionally by status, intent, or date.
Inputs
medication_request_idstringrequired- FHIR logical ID of the medication request (order or reported medication), from a search result or a reference such as MedicationRequest/<id>. Example: 12345
oraclehealth_medication_request_searchSearch medication requests in Oracle Health for a patient, optionally by status, intent, or date.Read-onlySearch Medication Requests
Search medication requests in Oracle Health for a patient, optionally by status, intent, or date. Returns a FHIR Bundle of MedicationRequest resources (medication code, status, intent, dosage instructions, requester, and dispense details) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_medication_request_search to find or list records. Use oraclehealth_medication_request_read to fetch one known ID.
Inputs
_countinteger- Maximum number of results per page. Example: 20
_idstring- Logical ID of the medication request to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
_lastUpdatedarray- Filter medication requests by when they were last updated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z"]
intentstring- Intent to filter by; several may be comma-separated: order (authorizations) or plan (reported medications). Example: order,plan
patientstring- FHIR logical ID of the patient whose medication requests to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
statusstring- Status to filter by; several may be comma-separated, for example active,completed. Example: active
timing_bounds_periodstring- Return medications whose dosage timing period includes or follows this date-time. Must use the ge prefix. Example: ge2024-01-01T00:00:00Z
oraclehealth_next_pageFetch the next page of results from a previous Oracle Health search tool by following its Bundle's next link.Read-onlyGet Next Page of Search Results
Fetch the next page of results from a previous Oracle Health search tool by following its Bundle's next link. Returns a FHIR Bundle of the same resource type; when that Bundle has no next link, it is the last page. Use oraclehealth_next_page only to continue a search. Start a new search with the matching oraclehealth_*_search tool.
Inputs
next_page_pathstringrequired- The part of the search result's next link (the Bundle link with relation "next") that comes after /r4/<tenant-id>/, starting with the resource type, with no leading slash. Copy it exactly as it appears in the link, including the -pageContext and -pageDirection parameters; don't decode, rebuild, or edit it. Example: for the next link https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationDispense?patient=12621984&-pageContext=a7824f7f-3471-4609-ae68-d794969f9878&-pageDirection=NEXT pass MedicationDispense?patient=12621984&-pageContext=a7824f7f-3471-4609-ae68-d794969f9878&-pageDirection=NEXT
oraclehealth_nutrition_order_readGet one nutrition order from Oracle Health by its FHIR logical ID.Read-onlyGet Nutrition Order
Get one nutrition order from Oracle Health by its FHIR logical ID. Returns the FHIR NutritionOrder resource: diet, supplement, and feeding instructions, status, orderer, and timing, plus meta.versionId. Use oraclehealth_nutrition_order_read when you have the ID. Use oraclehealth_nutrition_order_search to find nutrition orders for a patient, optionally by status or last update.
Inputs
nutrition_order_idstringrequired- FHIR logical ID of the nutrition order, from a search result or a reference such as NutritionOrder/<id>. Example: 12345
oraclehealth_nutrition_order_searchSearch nutrition orders in Oracle Health for a patient, optionally by status or last update.Read-onlySearch Nutrition Orders
Search nutrition orders in Oracle Health for a patient, optionally by status or last update. Returns a FHIR Bundle of NutritionOrder resources (diet, supplement, and feeding instructions, status, orderer, and timing) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_nutrition_order_search to find or list records. Use oraclehealth_nutrition_order_read to fetch one known ID.
Inputs
_countinteger- Maximum number of results per page. Example: 20
_idstring- Logical ID of the nutrition order to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
_lastUpdatedarray- Filter nutrition orders by when they were last updated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z"]
patientstring- FHIR logical ID of the patient whose nutrition orders to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
statusstring- Order status to filter by, for example active. Example: active
oraclehealth_observation_readGet one observation from Oracle Health by its FHIR logical ID.Read-onlyGet Observation
Get one observation from Oracle Health by its FHIR logical ID. Returns the FHIR Observation resource: the observation code, category, value with units, effective time, interpretation, and reference range, plus meta.versionId. Use oraclehealth_observation_read when you have the ID. Use oraclehealth_observation_search to find observations for a patient by category (laboratory, vital-signs, social-history, and so on), code, or date.
Inputs
observation_idstringrequired- FHIR logical ID of the observation, from a search result or a reference such as Observation/<id>. Example: 12345
oraclehealth_observation_searchSearch observations in Oracle Health for a patient by category (laboratory, vital-signs, social-history, and so on), code, or date.Read-onlySearch Observations
Search observations in Oracle Health for a patient by category (laboratory, vital-signs, social-history, and so on), code, or date. Returns a FHIR Bundle of Observation resources (the observation code, category, value with units, effective time, interpretation, and reference range) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_observation_search to find or list records. Use oraclehealth_observation_read to fetch one known ID.
Inputs
_countinteger- Maximum number of results per page. Default 50, maximum 200. Example: 20
_idstring- Logical ID of the observation to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
_lastUpdatedarray- Filter observations by when they were last updated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z"]
categorystring- Observation category, for example laboratory, vital-signs, social-history, imaging, survey, or exam. Example: laboratory
codestring- Observation code to filter by, as system|code or code; several may be comma-separated. Ignored when category is set. Example: http://loinc.org|8867-4
datearray- Filter by when the observation was made (effective time). Can't be combined with _lastUpdated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z", "lt2024-02-01T00:00:00Z"]
patientstring- FHIR logical ID of the patient whose observations to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
oraclehealth_organization_readGet one organization from Oracle Health by its FHIR logical ID.Read-onlyGet Organization
Get one organization from Oracle Health by its FHIR logical ID. Returns the FHIR Organization resource: name, type, identifiers (NPI, tax ID), address, and contact details, plus meta.versionId. Use oraclehealth_organization_read when you have the ID. Use oraclehealth_organization_search to find organizations by name, identifier, type, or address.
Inputs
organization_idstringrequired- FHIR logical ID of the organization, from a search result or a reference such as Organization/<id>. Example: 12345
oraclehealth_organization_searchSearch organizations in Oracle Health by name, identifier, type, or address.Read-onlySearch Organizations
Search organizations in Oracle Health by name, identifier, type, or address. Returns a FHIR Bundle of Organization resources (name, type, identifiers (NPI, tax ID), address, and contact details) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_organization_search to find or list records. Use oraclehealth_organization_read to fetch one known ID.
Inputs
_countinteger- Maximum number of results per page. Default 100. Example: 20
_idstring- Logical ID of the organization to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
addressstring- Start of the organization's street, city, state, or postal code. Example: 100
identifierstring- Organization identifier such as NPI or tax ID, as system|value or value. Example: http://hl7.org/fhir/sid/us-npi|0000000000
namestring- Organization name. Example: Example Clinic
typestring- Organization type as system|code (standard codes only). Example: http://terminology.hl7.org/CodeSystem/organization-type|prov
oraclehealth_patient_readGet one patient from Oracle Health by its FHIR logical ID.Read-onlyGet Patient
Get one patient from Oracle Health by its FHIR logical ID. Returns the FHIR Patient resource: demographics, identifiers (such as MRN), contact details, and links to related people, plus meta.versionId. Use oraclehealth_patient_read when you have the ID. Use oraclehealth_patient_search to find patients by name, birth date, identifier, phone, email, postal code, or gender.
Inputs
patient_idstringrequired- FHIR logical ID of the patient, from a search result or a reference such as Patient/<id>. Example: 12345
oraclehealth_patient_searchSearch patients in Oracle Health by name, birth date, identifier, phone, email, postal code, or gender.Read-onlySearch Patients
Search patients in Oracle Health by name, birth date, identifier, phone, email, postal code, or gender. Returns a FHIR Bundle of Patient resources (demographics, identifiers (such as MRN), contact details, and links to related people) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_patient_search to find or list records. Use oraclehealth_patient_read to fetch one known ID. Oracle Health returns a 422 error when more than 1000 patients match a search, so narrow name searches with birthdate or gender.
Inputs
_countinteger- Maximum number of results per page. Example: 20
_idstring- Logical ID of the patient to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
address_postalcodestring- Postal code of the patient's address. Example: 00000
birthdatearray- Filter by date of birth (date only, no time). Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example of an exact date: ["eq2000-01-01"]. Example: ["ge1990-01-01", "le1990-12-31"]
emailstring- Patient email address. Example: patient@example.com
familystring- Start of the patient's family (last) name. Example: Testpatient
genderstring- Administrative gender: male, female, other, or unknown.one of
malefemaleotherunknown givenstring- Start of the patient's given (first) name. Requires family. Example: Testname
identifierstring- Patient identifier as system|value, or just the value to search every identifier system (for example an MRN). Example: urn:oid:1.2.3.4|0000000
namestring- Start of any part of the patient's name (given or family). At least 2 characters. Don't combine with family or given. Example: Testp
phonestring- Patient phone number. Example: 5550100000
oraclehealth_practitioner_readGet one practitioner from Oracle Health by its FHIR logical ID.Read-onlyGet Practitioner
Get one practitioner from Oracle Health by its FHIR logical ID. Returns the FHIR Practitioner resource: name, identifiers (such as NPI), contact details, and active flag, plus meta.versionId. Use oraclehealth_practitioner_read when you have the ID. Use oraclehealth_practitioner_search to find practitioners by name, identifier (such as NPI), or active flag.
Inputs
practitioner_idstringrequired- FHIR logical ID of the practitioner, from a search result or a reference such as Practitioner/<id>. Example: 12345
oraclehealth_practitioner_searchSearch practitioners in Oracle Health by name, identifier (such as NPI), or active flag.Read-onlySearch Practitioners
Search practitioners in Oracle Health by name, identifier (such as NPI), or active flag. Returns a FHIR Bundle of Practitioner resources (name, identifiers (such as NPI), contact details, and active flag) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_practitioner_search to find or list records. Use oraclehealth_practitioner_read to fetch one known ID.
Inputs
_countinteger- Maximum number of results per page. Example: 20
_idstring- Logical ID of the practitioner to return. Several IDs may be comma-separated. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
activeboolean- Whether the practitioner record is active (true or false). Example: true
familystring- Start of the practitioner's family name. Example: Testdoctor
givenstring- Start of the practitioner's given name. Requires family. Example: Testname
identifierstring- Practitioner identifier as system|value; both are required. Example: http://hl7.org/fhir/sid/us-npi|0000000000
namestring- Start of any part of the practitioner's name. Example: Testd
oraclehealth_procedure_readGet one procedure from Oracle Health by its FHIR logical ID.Read-onlyGet Procedure
Get one procedure from Oracle Health by its FHIR logical ID. Returns the FHIR Procedure resource: procedure code, status, performed date or period, performers, location, and notes, plus meta.versionId. Use oraclehealth_procedure_read when you have the ID. Use oraclehealth_procedure_search to find procedures for a patient, optionally by date or last update.
Inputs
procedure_idstringrequired- FHIR logical ID of the procedure, from a search result or a reference such as Procedure/<id>. Example: 12345
oraclehealth_procedure_searchSearch procedures in Oracle Health for a patient, optionally by date or last update.Read-onlySearch Procedures
Search procedures in Oracle Health for a patient, optionally by date or last update. Returns a FHIR Bundle of Procedure resources (procedure code, status, performed date or period, performers, location, and notes) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_procedure_search to find or list records. Use oraclehealth_procedure_read to fetch one known ID.
Inputs
_idstring- Logical ID of the procedure to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
_lastUpdatedarray- Filter procedures by when they were last updated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z"]
datearray- Filter by when the procedure was performed; each value needs a time component. Can't be combined with _lastUpdated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z", "lt2024-02-01T00:00:00Z"]
patientstring- FHIR logical ID of the patient whose procedures to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
oraclehealth_provenance_readGet one provenance record from Oracle Health by its FHIR logical ID.Read-onlyGet Provenance
Get one provenance record from Oracle Health by its FHIR logical ID. Returns the FHIR Provenance resource: who created or changed the target record, when, and on whose behalf, plus meta.versionId. Use oraclehealth_provenance_read when you have the ID. Use oraclehealth_provenance_search to find provenance records for one or more target records.
Inputs
provenance_idstringrequired- FHIR logical ID of the provenance record, from a search result or a reference such as Provenance/<id>. Example: 12345
oraclehealth_provenance_searchSearch provenance records in Oracle Health for one or more target records.Read-onlySearch Provenances
Search provenance records in Oracle Health for one or more target records. Returns a FHIR Bundle of Provenance resources (who created or changed the target record, when, and on whose behalf) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_provenance_search to find or list records. Use oraclehealth_provenance_read to fetch one known ID.
Inputs
_idstring- Logical ID of the provenance record to return. Several IDs may be comma-separated. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
targetstring- Record(s) to return provenance for, as ResourceType/id; several may be comma-separated. Required unless _id is given. Example: Condition/12345
oraclehealth_questionnaire_readGet one questionnaire from Oracle Health by its FHIR logical ID.Read-onlyGet Questionnaire
Get one questionnaire from Oracle Health by its FHIR logical ID. Returns the FHIR Questionnaire resource: the questionnaire's title, status, and items (questions). Use oraclehealth_questionnaire_read with an ID taken from a reference in another resource; Oracle Health offers no useful search for Questionnaire.
Inputs
questionnaire_idstringrequired- FHIR logical ID of the questionnaire, from a reference such as Questionnaire/<id>. Example: 12345
oraclehealth_questionnaire_response_readGet one questionnaire response from Oracle Health by its FHIR logical ID.Read-onlyGet Questionnaire Response
Get one questionnaire response from Oracle Health by its FHIR logical ID. Returns the FHIR QuestionnaireResponse resource: the questionnaire answered, status, author, authored time, and the answers, plus meta.versionId. Use oraclehealth_questionnaire_response_read when you have the ID. Use oraclehealth_questionnaire_response_search to find questionnaire responses for a patient.
Inputs
questionnaire_response_idstringrequired- FHIR logical ID of the questionnaire response, from a search result or a reference such as QuestionnaireResponse/<id>. Example: 12345
oraclehealth_questionnaire_response_searchSearch questionnaire responses in Oracle Health for a patient.Read-onlySearch Questionnaire Responses
Search questionnaire responses in Oracle Health for a patient. Returns a FHIR Bundle of QuestionnaireResponse resources (the questionnaire answered, status, author, authored time, and the answers) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_questionnaire_response_search to find or list records. Use oraclehealth_questionnaire_response_read to fetch one known ID.
Inputs
_idstring- Logical ID of the questionnaire response to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
patientstring- FHIR logical ID of the patient whose questionnaire responses to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
oraclehealth_schedule_readGet one schedule from Oracle Health by its FHIR logical ID.Read-onlyGet Schedule
Get one schedule from Oracle Health by its FHIR logical ID. Returns the FHIR Schedule resource: the schedule's actors (practitioner or location), service types, and planning horizon. Use oraclehealth_schedule_read with an ID taken from a reference in another resource; Oracle Health offers no useful search for Schedule.
Inputs
schedule_idstringrequired- FHIR logical ID of the schedule, from a reference such as Schedule/<id>. Example: 12345
oraclehealth_service_request_readGet one service request (order or referral) from Oracle Health by its FHIR logical ID.Read-onlyGet Service Request
Get one service request (order or referral) from Oracle Health by its FHIR logical ID. Returns the FHIR ServiceRequest resource: order or referral code, status, intent, priority, requester, reason, and occurrence, plus meta.versionId. Use oraclehealth_service_request_read when you have the ID. Use oraclehealth_service_request_search to find service requests for a patient, optionally by code or last update.
Inputs
service_request_idstringrequired- FHIR logical ID of the service request (order or referral), from a search result or a reference such as ServiceRequest/<id>. Example: 12345
oraclehealth_service_request_searchSearch service requests in Oracle Health for a patient, optionally by code or last update.Read-onlySearch Service Requests
Search service requests in Oracle Health for a patient, optionally by code or last update. Returns a FHIR Bundle of ServiceRequest resources (order or referral code, status, intent, priority, requester, reason, and occurrence) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_service_request_search to find or list records. Use oraclehealth_service_request_read to fetch one known ID.
Inputs
_countinteger- Maximum number of results per page. Default 50. Example: 20
_idstring- Logical ID of the service request to return. Several IDs may be comma-separated. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
_lastUpdatedarray- Filter service requests by when they were last updated. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z"]
codestring- What was ordered, as system|code or code (SNOMED CT, LOINC, or the tenant's Millennium code sets). Example: http://loinc.org|24323-8
patientstring- FHIR logical ID of the patient whose service requests to return, without the 'Patient/' prefix. Required unless _id is given. Find it with oraclehealth_patient_search. Example: 12345
oraclehealth_slot_readGet one schedulable slot from Oracle Health by its FHIR logical ID.Read-onlyGet Slot
Get one schedulable slot from Oracle Health by its FHIR logical ID. Returns the FHIR Slot resource: start and end time, status (free or busy), schedule, and the appointment types it accepts, plus meta.versionId. Use oraclehealth_slot_read when you have the ID. Use oraclehealth_slot_search to find open appointment slots by appointment type, practitioner, or location in a start-time range.
Inputs
slot_idstringrequired- FHIR logical ID of the schedulable slot, from a search result or a reference such as Slot/<id>. Example: 12345
oraclehealth_slot_searchSearch open appointment slots in Oracle Health by appointment type, practitioner, or location in a start-time range.Read-onlySearch Slots
Search open appointment slots in Oracle Health by appointment type, practitioner, or location in a start-time range. Returns a FHIR Bundle of Slot resources (start and end time, status (free or busy), schedule, and the appointment types it accepts) with a next link when more pages exist. If the result has a `next` link, use `oraclehealth_next_page` to get more. Use oraclehealth_slot_search to find or list records. Use oraclehealth_slot_read to fetch one known ID. Book a returned slot with oraclehealth_appointment_create.
Inputs
_countinteger- Maximum number of results per page. Example: 20
_idstring- Logical ID of the slot to return. Use instead of the other filters; Oracle Health rejects _id combined with most other parameters. Example: 12345
locationstring- FHIR logical ID of the location the slot belongs to. Example: 34567
schedule_actorstring- Practitioner whose schedule to search, as Practitioner/<id>. Example: Practitioner/23456
service_typestring- Appointment type(s) the slot accepts, as system|code; several may be comma-separated. Required unless _id, location, or schedule_actor is given. Example: https://fhir.cerner.com/<tenant>/codeSet/14249|000000
startarray- Slot start range. Required with service_type, location, or schedule_actor; must have two values, one ge and one lt. Pass one or two values as a JSON array; each value carries a FHIR prefix (eq, ge, gt, le, lt) and is sent as a repeated query parameter. Two values must form a range: the lower one with ge or gt, the upper one with le or lt. Example: ["ge2024-01-01T00:00:00Z", "lt2024-02-01T00:00:00Z"]
oraclehealth_specimen_readGet one specimen from Oracle Health by its FHIR logical ID.Read-onlyGet Specimen
Get one specimen from Oracle Health by its FHIR logical ID. Returns the FHIR Specimen resource: specimen type, collection details, status, and the patient. Use oraclehealth_specimen_read with an ID taken from a reference in another resource; Oracle Health offers no useful search for Specimen.
Inputs
specimen_idstringrequired- FHIR logical ID of the specimen, from a reference such as Specimen/<id>. Example: 12345
oraclehealth_allergy_intolerance_createRecord a new allergy or intolerance on a patient's chart in Oracle Health.WriteCreate Allergy Intolerance
Record a new allergy or intolerance on a patient's chart in Oracle Health. Returns an empty body with HTTP 201 on success; Oracle Health puts the new resource's URL in the Location header and its version in the ETag header. Use it to add an allergy. Use oraclehealth_allergy_intolerance_update to change an existing one, and oraclehealth_allergy_intolerance_search to check for duplicates first.
Inputs
clinical_statusstringrequired- Clinical status of the allergy: active, inactive, or resolved. Example: activeone of
activeinactiveresolved codestringrequired- Code of the allergen substance in code_system. Use a substance code, not a finding or disorder code: Oracle Health returns a 500 error for findings such as SNOMED 91936005 (allergy to penicillin). Example: 227493005 (cashew nut, SNOMED substance)
code_systemstringrequired- Code system of the allergen. Example: http://snomed.info/sct (RxNorm http://www.nlm.nih.gov/research/umls/rxnorm is also common)
patient_idstringrequired- FHIR logical ID of the patient, without the 'Patient/' prefix. Find it with oraclehealth_patient_search. Example: 12345
categorystring- Category of the allergen: food, medication, or environment (biologic is not supported). Example: medicationone of
foodmedicationenvironment code_textstring- Human-readable name of the allergen. Example: Cashew nuts
criticalitystring- Potential harm of a future reaction: low, high, or unable-to-assess. Example: highone of
lowhighunable-to-assess encounter_idstring- FHIR logical ID of the encounter, without the 'Encounter/' prefix. Encounter in which the allergy was recorded. Example: 67890
notestring- Free-text note about the allergy. Example: Reported by patient at intake.
onset_date_timestring- When the allergy began. Oracle Health stores only the date (GMT). ISO 8601 date-time with a time component and offset. Example: 2024-01-15T09:30:00Z
reaction_manifestation_codestring- Code of the reaction symptom (one manifestation only). Set with reaction_manifestation_system. Example: 271807003 (rash)
reaction_manifestation_systemstring- Code system of the reaction symptom. Example: http://snomed.info/sct
reaction_manifestation_textstring- Text of the reaction symptom; enough on its own when no code is known. Example: Rash
reaction_severitystring- Severity of the reaction: mild, moderate, or severe. Needs a reaction manifestation. Example: moderateone of
mildmoderatesevere typestring- Underlying mechanism: allergy or intolerance. Example: allergyone of
allergyintolerance verification_statusstring- Verification status: unconfirmed or confirmed (refuted and entered-in-error are not allowed on create). Example: confirmedone of
unconfirmedconfirmed
oraclehealth_allergy_intolerance_updateReplace an existing allergy or intolerance in Oracle Health with an edited copy (FHIR update).WriteUpdate Allergy Intolerance
Replace an existing allergy or intolerance in Oracle Health with an edited copy (FHIR update). Returns an empty body on success; the new version is in the ETag response header. Use it after oraclehealth_allergy_intolerance_read: change the fields you need and send the whole resource back. Use oraclehealth_allergy_intolerance_create for a new record.
- Idempotent
Inputs
allergy_intolerance_idstringrequired- FHIR logical ID of the allergy or intolerance to update. Example: 12345
resourceobjectrequired- The complete AllergyIntolerance resource as JSON, usually the output of oraclehealth_allergy_intolerance_read with your changes applied. Oracle Health replaces the whole record: any field you leave out is cleared. resourceType and id are set by the tool. Example: {"resourceType": "AllergyIntolerance", "id": "12345", ...}
version_idstringrequired- Current version, from meta.versionId of oraclehealth_allergy_intolerance_read; sent as If-Match: W/"<version>". A stale version is rejected. Example: 3
oraclehealth_appointment_cancelCancel an appointment in Oracle Health with a JSON Patch, optionally with a cancellation reason.WriteCancel Appointment
Cancel an appointment in Oracle Health with a JSON Patch, optionally with a cancellation reason. Returns an empty body on success; the new version is in the ETag response header. Use it to cancel a booked appointment. Get version_id from oraclehealth_appointment_read; a stale version returns 409 Conflict.
Inputs
appointment_idstringrequired- FHIR logical ID of the appointment. Example: 12345
version_idstringrequired- Current version, from meta.versionId of oraclehealth_appointment_read; sent as If-Match: W/"<version>". Example: 3
cancelation_reason_codestring- FHIR appointment-cancellation-reason code, for example pat (patient), prov (provider), or oth-err (error). Example: pat
oraclehealth_appointment_createBook an appointment for a patient into an open scheduling slot in Oracle Health.WriteBook Appointment
Book an appointment for a patient into an open scheduling slot in Oracle Health. Returns an empty body with HTTP 201 on success; Oracle Health puts the new resource's URL in the Location header and its version in the ETag header. Use it after oraclehealth_slot_search returns a free slot; the slot sets the practitioner, location, and time. Use oraclehealth_appointment_cancel to cancel it.
Inputs
patient_idstringrequired- FHIR logical ID of the patient, without the 'Patient/' prefix. Find it with oraclehealth_patient_search. Example: 12345
slot_idstringrequired- FHIR logical ID of a free Slot from oraclehealth_slot_search. Example: 00000-11111-22222-0
commentstring- Additional text to help with the appointment. Example: Patient prefers morning.
reason_textstring- Reason for the visit, as text. Example: Follow-up visit
oraclehealth_communication_createSend a message to practitioners' or pools' Oracle Health inboxes as a Communication, optionally about a patient.WriteSend Inbox Message
Send a message to practitioners' or pools' Oracle Health inboxes as a Communication, optionally about a patient. Returns an empty body with HTTP 201 on success; Oracle Health puts the new resource's URL in the Location header and its version in the ETag header. Use it to notify colleagues in the EHR. Use oraclehealth_communication_search to list messages a practitioner received.
Inputs
categorystringrequired- Message category: notification or reminder. Example: notificationone of
notificationreminder message_textstringrequired- Plain-text body of the message; the tool base64-encodes it with contentType text/plain. Example: Please review the latest results.
sender_practitioner_idstringrequired- FHIR logical ID of the sending Practitioner (usually the signed-in clinician). Example: 23456
encounter_idstring- FHIR logical ID of the encounter, without the 'Encounter/' prefix. Needs patient_id. Example: 67890
patient_idstring- FHIR logical ID of the patient the message is about. Required when encounter_id is set. Example: 12345
prioritystring- Priority: routine or urgent. Example: routineone of
routineurgent recipient_group_idsarray- Group (pool) FHIR IDs to receive the message. Example: ["56789"]
recipient_practitioner_idsarray- Practitioner FHIR IDs to receive the message. Set this, recipient_group_ids, or both. Example: ["23456"]
topicstring- Subject line of the message. Example: Lab follow-up
oraclehealth_condition_createAdd a problem-list item or an encounter diagnosis to a patient's chart in Oracle Health.WriteCreate Condition
Add a problem-list item or an encounter diagnosis to a patient's chart in Oracle Health. Returns an empty body with HTTP 201 on success; Oracle Health puts the new resource's URL in the Location header and its version in the ETag header. Use it to record a new problem or diagnosis. Use oraclehealth_condition_update to change an existing one, and oraclehealth_condition_search to check for duplicates first.
Inputs
categorystringrequired- Condition category: problem-list-item or encounter-diagnosis (the only two Oracle Health accepts on create). An encounter-diagnosis needs encounter_id. Example: problem-list-itemone of
problem-list-itemencounter-diagnosis clinical_statusstringrequired- Clinical status: active, recurrence, relapse, inactive, remission, or resolved. Only active is allowed for encounter-diagnosis. Example: activeone of
activerecurrencerelapseinactiveremissionresolved codestringrequired- Condition code in code_system. Example: 44054006 (type 2 diabetes mellitus)
code_systemstringrequired- Code system of the condition. Example: http://snomed.info/sct (ICD-10-CM is http://hl7.org/fhir/sid/icd-10-cm)
patient_idstringrequired- FHIR logical ID of the patient, without the 'Patient/' prefix. Find it with oraclehealth_patient_search. Example: 12345
abatement_date_timestring- When the condition resolved. Not allowed for encounter-diagnosis. ISO 8601 date-time with a time component and offset. Example: 2024-01-15T09:30:00Z
code_displaystring- Display name for the code. Example: Type 2 diabetes mellitus
encounter_idstring- FHIR logical ID of the encounter, without the 'Encounter/' prefix. Required when category is encounter-diagnosis. Example: 67890
notestring- Free-text note about the condition. Can't be changed later. Example: Diet-controlled.
onset_date_timestring- When the condition began. Stored as a GMT date. ISO 8601 date-time with a time component and offset. Example: 2024-01-15T09:30:00Z
verification_statusstring- Verification status: unconfirmed, provisional, differential, or confirmed. Example: confirmedone of
unconfirmedprovisionaldifferentialconfirmed
oraclehealth_condition_updateReplace an existing condition (problem or diagnosis) in Oracle Health with an edited copy (FHIR update).WriteUpdate Condition
Replace an existing condition (problem or diagnosis) in Oracle Health with an edited copy (FHIR update). Returns an empty body on success; the new version is in the ETag response header. Use it after oraclehealth_condition_read: change the fields you need and send the whole resource back. Only problem-list-item and encounter-diagnosis conditions can be updated. Use oraclehealth_condition_create for a new record.
- Idempotent
Inputs
condition_idstringrequired- FHIR logical ID of the condition (problem or diagnosis) to update. Example: 12345
resourceobjectrequired- The complete Condition resource as JSON, usually the output of oraclehealth_condition_read with your changes applied. Oracle Health replaces the whole record: any field you leave out is cleared. resourceType and id are set by the tool. Example: {"resourceType": "Condition", "id": "12345", ...}
version_idstringrequired- Current version, from meta.versionId of oraclehealth_condition_read; sent as If-Match: W/"<version>". A stale version is rejected. Example: 3
oraclehealth_document_reference_createWrite a final clinical note (DocumentReference) to a patient's chart in Oracle Health.WriteCreate Clinical Note
Write a final clinical note (DocumentReference) to a patient's chart in Oracle Health. Returns an empty body with HTTP 201 on success; Oracle Health puts the new resource's URL in the Location header and its version in the ETag header. Use it to file a note written by the signed-in clinician. Pass plain text in note_text, or other supported formats as base64 in content_base64. Use oraclehealth_document_reference_update to amend a note.
Inputs
author_practitioner_idstringrequired- FHIR logical ID of the signed-in clinician's Practitioner record (the fhirUser). Oracle Health accepts only the authorized provider as author. Example: 23456
patient_idstringrequired- FHIR logical ID of the patient, without the 'Patient/' prefix. Find it with oraclehealth_patient_search. Example: 12345
period_endstringrequired- End of the time of service the note documents. ISO 8601 date-time with a time component and offset. Example: 2024-01-15T09:30:00Z
period_startstringrequired- Start of the time of service the note documents. ISO 8601 date-time with a time component and offset. Example: 2024-01-15T09:30:00Z
type_codestringrequired- Note type code. Example: 11506-3 (progress note)
type_systemstringrequired- Code system of the note type: LOINC (http://loinc.org) or the tenant's Millennium code set 72 (https://fhir.cerner.com/<tenant id>/codeSet/72), not both. Example: http://loinc.org
content_base64string- Base64-encoded document for non-plain-text formats; used instead of note_text. Example: PGh0bWw+PC9odG1sPg==
content_typestring- MIME type of content_base64: application/pdf, text/plain, text/richtext, text/rtf, text/html, application/xml, or application/xhtml+xml. Required with content_base64. Example: text/htmlone of
application/pdftext/plaintext/richtexttext/rtftext/htmlapplication/xmlapplication/xhtml+xml encounter_idstring- FHIR logical ID of the encounter, without the 'Encounter/' prefix. Encounter the note belongs to. Example: 67890
note_textstring- Plain-text body of the note; the tool base64-encodes it and sends contentType text/plain. Set this or content_base64. Example: Patient seen for follow-up. Stable.
titlestring- Title of the attachment. Example: Follow-up visit note
type_displaystring- Display name of the note type. Example: Progress note
oraclehealth_document_reference_updateReplace an existing clinical document reference in Oracle Health with an edited copy (FHIR update).WriteUpdate Document Reference
Replace an existing clinical document reference in Oracle Health with an edited copy (FHIR update). Returns an empty body on success; the new version is in the ETag response header. Use it after oraclehealth_document_reference_read: change the fields you need and send the whole resource back. To amend a note, set docStatus to amended (system access) or replace the content; setting entered-in-error keeps the original content. Use oraclehealth_document_reference_create for a new record.
- Idempotent
Inputs
document_reference_idstringrequired- FHIR logical ID of the clinical document reference to update. Example: 12345
resourceobjectrequired- The complete DocumentReference resource as JSON, usually the output of oraclehealth_document_reference_read with your changes applied. Oracle Health replaces the whole record: any field you leave out is cleared. resourceType and id are set by the tool. Example: {"resourceType": "DocumentReference", "id": "12345", ...}
version_idstringrequired- Current version, from meta.versionId of oraclehealth_document_reference_read; sent as If-Match: W/"<version>". A stale version is rejected. Example: 3
oraclehealth_immunization_createRecord a vaccine administration (or one not given) for a patient in Oracle Health.WriteCreate Immunization
Record a vaccine administration (or one not given) for a patient in Oracle Health. Returns an empty body with HTTP 201 on success; Oracle Health puts the new resource's URL in the Location header and its version in the ETag header. Use it to chart an immunization. Use oraclehealth_immunization_search to check the history first and oraclehealth_immunization_update to correct a record.
Inputs
occurrence_date_timestringrequired- When the vaccine was given. ISO 8601 date-time with a time component and offset. Example: 2024-01-15T09:30:00Z
patient_idstringrequired- FHIR logical ID of the patient, without the 'Patient/' prefix. Find it with oraclehealth_patient_search. Example: 12345
statusstringrequired- Event status: completed or not-done. Example: completedone of
completednot-done vaccine_codestringrequired- Vaccine code from Oracle Health's code set 72 (vaccine_code_system), not a CVX code. Example: 2820755 (influenza virus vaccine, inactivated)
vaccine_code_systemstringrequired- Code system of the vaccine. Oracle Health requires its own Millennium vaccine code set 72, https://fhir.cerner.com/<tenant id>/codeSet/72; it rejects standard CVX codes (http://hl7.org/fhir/sid/cvx) with "Vaccine Code is missing." Example: https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72
dose_unitstring- UCUM unit of the dose; required with dose_value. Example: mL
dose_valuenumber- Amount of vaccine given. Example: 0.5
encounter_idstring- FHIR logical ID of the encounter, without the 'Encounter/' prefix. Required to chart the immunization (optional only for staged records). Example: 67890
expiration_datestring- Expiration date of the vaccine lot (YYYY-MM-DD). Example: 2026-12-31
lot_numberstring- Vaccine lot number. Example: AB1234
notestring- Extra information about the immunization. Example: Patient tolerated well.
performer_practitioner_idstring- Who administered the vaccine (sent with the Administering Provider role). FHIR logical ID of a Practitioner, without the 'Practitioner/' prefix. Example: 23456
primary_sourceboolean- true when the record comes from the person who gave the vaccine (the default); false for a historical record. Example: true
vaccine_displaystring- Vaccine name. Example: influenza virus vaccine, inactivated
oraclehealth_immunization_updateReplace an existing immunization in Oracle Health with an edited copy (FHIR update).WriteUpdate Immunization
Replace an existing immunization in Oracle Health with an edited copy (FHIR update). Returns an empty body on success; the new version is in the ETag response header. Use it after oraclehealth_immunization_read: change the fields you need and send the whole resource back. Use oraclehealth_immunization_create for a new record.
- Idempotent
Inputs
immunization_idstringrequired- FHIR logical ID of the immunization to update. Example: 12345
resourceobjectrequired- The complete Immunization resource as JSON, usually the output of oraclehealth_immunization_read with your changes applied. Oracle Health replaces the whole record: any field you leave out is cleared. resourceType and id are set by the tool. Example: {"resourceType": "Immunization", "id": "12345", ...}
version_idstringrequired- Current version, from meta.versionId of oraclehealth_immunization_read; sent as If-Match: W/"<version>". A stale version is rejected. Example: 3
oraclehealth_medication_request_createDocument a medication the patient takes (a reported or historical medication) in Oracle Health.WriteCreate Medication Request
Document a medication the patient takes (a reported or historical medication) in Oracle Health. Returns an empty body with HTTP 201 on success; Oracle Health puts the new resource's URL in the Location header and its version in the ETag header. Use it to add a home or outside medication to the medication list; Oracle Health creates it with reportedBoolean true and status active, and it is not an e-prescription. Use oraclehealth_medication_request_update_status to stop or cancel it later.
Inputs
intentstringrequired- Intent: order or plan. Example: planone of
orderplan patient_idstringrequired- FHIR logical ID of the patient, without the 'Patient/' prefix. Find it with oraclehealth_patient_search. Example: 12345
additional_instructionstring- Extra instruction or warning for the patient. Example: Take with food.
dosage_textstring- Free-text dosage instructions. Example: 1 tablet by mouth twice daily
encounter_idstring- FHIR logical ID of the encounter, without the 'Encounter/' prefix. Example: 67890
end_date_timestring- When the medication ends (dosage timing bounds end). ISO 8601 date-time with a time component and offset. Example: 2024-01-15T09:30:00Z
medication_codestring- Medication code in medication_system. Example: 000000
medication_systemstring- Code system of the medication. Set with medication_code, or use medication_text alone. Example: http://www.nlm.nih.gov/research/umls/rxnorm
medication_textstring- Medication name as text. Required when no code is given. Example: Acetaminophen 500 mg tablet
notestring- Note about the medication. Example: Patient has taken this medication before.
start_date_timestring- When the patient started the medication (dosage timing bounds start). ISO 8601 date-time with a time component and offset. Example: 2024-01-15T09:30:00Z
oraclehealth_medication_request_update_statusStop or cancel a documented (reported) medication in Oracle Health with a JSON Patch on its status.WriteStop or Cancel Medication Request
Stop or cancel a documented (reported) medication in Oracle Health with a JSON Patch on its status. Returns an empty body on success; the new version is in the ETag response header. Use stopped when the medication's start date is in the past and cancelled when it never started. Only historical documented medications (intent order, reported) can change; get version_id from oraclehealth_medication_request_read.
Inputs
medication_request_idstringrequired- FHIR logical ID of the medication request. Example: 12345
statusstringrequired- New status: stopped or cancelled. Example: stoppedone of
stoppedcancelled version_idstringrequired- Current version of the resource, from meta.versionId of oraclehealth_medication_request_read; sent as If-Match: W/"<version>". Example: 3
oraclehealth_observation_createRecord a vital sign or laboratory result for a patient in Oracle Health.WriteCreate Observation
Record a vital sign or laboratory result for a patient in Oracle Health. Returns an empty body with HTTP 201 on success; Oracle Health puts the new resource's URL in the Location header and its version in the ETag header. Use it for single-value vitals (temperature, heart rate, weight, height) and lab values. Blood pressure and pulse oximetry need components and are not supported by this tool. Use oraclehealth_observation_update to correct an existing result.
Inputs
categorystringrequired- Observation category: vital-signs or laboratory. Example: vital-signsone of
vital-signslaboratory codestringrequired- Code of what was observed. Example: 8310-5 (body temperature)
code_systemstringrequired- Code system of what was observed. Example: http://loinc.org
effective_date_timestringrequired- When the observation was made. ISO 8601 date-time with a time component and offset. Example: 2024-01-15T09:30:00Z
patient_idstringrequired- FHIR logical ID of the patient, without the 'Patient/' prefix. Find it with oraclehealth_patient_search. Example: 12345
statusstringrequired- Result status: final, amended, or corrected. Example: finalone of
finalamendedcorrected code_textstring- Human-readable name of the observation. Example: Temperature
encounter_idstring- FHIR logical ID of the encounter, without the 'Encounter/' prefix. Example: 67890
notestring- Comment about the observation. Example: Taken after exercise.
performer_practitioner_idstring- Required for vital signs. Who made the observation; sent with the legal-authenticator (LA) role. FHIR logical ID of a Practitioner, without the 'Practitioner/' prefix. Example: 23456
value_quantitynumber- Numeric value. Set this or value_string. Vital signs accept only numeric values. Example: 37.2
value_stringstring- Text value, for laboratory results only. Set this or value_quantity. Example: Negative
value_unitstring- Unit shown with value_quantity. Example: degC
value_unit_codestring- UCUM code for the unit; when set, the system http://unitsofmeasure.org is sent. Example: Cel
oraclehealth_observation_updateReplace an existing observation in Oracle Health with an edited copy (FHIR update).WriteUpdate Observation
Replace an existing observation in Oracle Health with an edited copy (FHIR update). Returns an empty body on success; the new version is in the ETag response header. Needs both Observation read and write scopes. Use it after oraclehealth_observation_read: change the fields you need and send the whole resource back. Only laboratory, imaging, and vital-signs observations can be updated, and patient and category can't change. Use oraclehealth_observation_create for a new record.
- Idempotent
Inputs
observation_idstringrequired- FHIR logical ID of the observation to update. Example: 12345
resourceobjectrequired- The complete Observation resource as JSON, usually the output of oraclehealth_observation_read with your changes applied. Oracle Health replaces the whole record: any field you leave out is cleared. resourceType and id are set by the tool. Example: {"resourceType": "Observation", "id": "12345", ...}
version_idstringrequired- Current version, from meta.versionId of oraclehealth_observation_read; sent as If-Match: W/"<version>". A stale version is rejected. Example: 3
oraclehealth_procedure_createDocument a completed procedure for a patient in Oracle Health.WriteCreate Procedure
Document a completed procedure for a patient in Oracle Health. Returns an empty body with HTTP 201 on success; Oracle Health puts the new resource's URL in the Location header and its version in the ETag header. Use it to record a procedure that was performed (status is always completed). Use oraclehealth_procedure_search to review existing procedures.
Inputs
codestringrequired- Procedure code in code_system. Example: 80146002 (appendectomy)
code_systemstringrequired- Code system of the procedure. Example: http://snomed.info/sct
patient_idstringrequired- FHIR logical ID of the patient, without the 'Patient/' prefix. Find it with oraclehealth_patient_search. Example: 12345
code_displaystring- Display name of the procedure. Example: Appendectomy
encounter_idstring- FHIR logical ID of the encounter, without the 'Encounter/' prefix. Encounter in which the procedure was performed. Example: 67890
location_idstring- FHIR logical ID of the Location where the procedure happened. Example: 34567
notestring- Comment about the procedure. Example: No complications.
performed_date_timestring- When the procedure was performed. Stored as a GMT date. ISO 8601 date-time with a time component and offset. Example: 2024-01-15T09:30:00Z
performer_practitioner_idstring- Who performed the procedure. FHIR logical ID of a Practitioner, without the 'Practitioner/' prefix. Example: 23456
No tools match.
