Jump to Content
API Reference
Documentation
v1.0.0
API Reference
Moon (Dark Mode)
Sun (Light Mode)
v1.0.0
API Reference
Documentation
Update Goal with identifier {identifier}
Search
JUMP TO
Oystehr Project API documentation
Applications
Get applications
get
Create an application
post
Delete an application
delete
Get an application
get
Update an application
patch
Rotate application's secret
post
Revokes user's refresh token
post
Revokes user's access token
post
Developers
Get a developer by ID
get
Update a developer
patch
Remove a developer
delete
Invite a developer
post
Get all developers
get
Get developers with pagination
get
M2M Clients
Create an M2M client
post
Get all M2M clients
get
Get an M2M client
get
Delete an M2M client
delete
Update an M2M client
patch
Rotate an M2M client secret
post
Get M2M clients with pagination
get
Messaging
Get a Messaging Services configuration
get
Create a Conversation
post
Get a Conversation Token
get
Add a participant to a Conversation
post
Remove a participant from a Conversation
delete
Send a message to a Conversation
post
Send a user an SMS
post
Payment
Set up a new payment method for user
post
Set a specified method as a default for the user
post
Delete payment method as a default for the beneficiary
delete
List all payment methods for the patient
post
Issue a charge for a paricutlar encounter.
post
Retrieve charge status for a paricutlar encounter.
post
Project
Get project settings
get
Update project settings
patch
RCM
Checks insurance eligibility.
post
Validates professional claim.
post
Submits professional claim to payer.
post
eRx
Sync patient with eRx service
post
Search for allergies
get
Cancel photon order
post
Cancel photon prescription
post
Search for medications (Deprecated, v1)
get
Search for medications (v2)
get
Roles
Create a new Role
post
Get all Roles
get
Get a Role by ID
get
Update a Role
patch
Delete a role
delete
Secrets
Create secret
post
Get all Secrets
get
Get a Secret
get
Delete a Secret
delete
Telemed
Create a telemedicine video meeting
post
Join a video meeting
get
Users
Get yourself
get
Get a User by ID
get
Update a specific user
patch
Delete a specific user
delete
Invite a User
post
Reset a User's MFA by ID
post
Get all users
get
Get users with pagination
get
Version
Get project API version
get
Z3
List all Z3 Buckets
get
Create a Z3 Bucket
put
Delete a Z3 Bucket
delete
List Z3 Objects in a Bucket
get
Delete a Z3 Object
delete
Get a link for uploading or downloading a Z3 Object
post
Zambda Functions
Create a Zambda Function
post
Get all Zambda Functions
get
Get a Zambda Function
get
Delete a Zambda Function
delete
Update a Zambda Function
patch
Execute an authenticated Zambda Function
post
Execute a public Zambda Function
post
Get a Zambda Function's log streams
post
Deploy code to a Zambda Function
post
Search all of a Zambda Function's logs
post
Get logs from a Zambda Function log stream
post
Oystehr Fax Service documentation
Fax
Offboard a fax number
post
Onboard a fax number
post
Send a fax
post
Oystehr Lab Service documentation
Lab
Get Routes
get
Create a Route
post
Delete a Route
delete
Search for orderable items
get
Get AOE Questionnaire
get
Submit a lab order
post
Oystehr eRx Service documentation
eRx
Search for allergens
get
Search for medications
get
Checks for drug-allergy interactions
get
Get project configuration
get
Checks for drug-drug interactions
get
Checks for drug-allergy and drug-drug interactions with a specific drug
get
Sync patient data with upstream eRx provider
post
Cancel patient's prescription
delete
Create an SSO link for a practitioner
get
Check eRx enrollment for a practitioner
get
Enroll a practitioner in eRx
post
Unenroll a practitioner from eRx
delete
Oystehr FHIR API documentation
Account
Search Accounts
get
Create a new Account
post
Search Accounts
post
Get Account with identifier {identifier}
get
Update Account with identifier {identifier}
put
Patch Account with identifier {identifier}
patch
Delete Account with identifier {identifier}
delete
Get history of Account with identifier {identifier}
get
Get Account with identifier {identifier} at version {versionIdentifier}
get
ActivityDefinition
Search ActivityDefinitions
get
Create a new ActivityDefinition
post
Search ActivityDefinitions
post
Get ActivityDefinition with identifier {identifier}
get
Update ActivityDefinition with identifier {identifier}
put
Patch ActivityDefinition with identifier {identifier}
patch
Delete ActivityDefinition with identifier {identifier}
delete
Get history of ActivityDefinition with identifier {identifier}
get
Get ActivityDefinition with identifier {identifier} at version {versionIdentifier}
get
AdministrableProductDefinition
Search AdministrableProductDefinitions
get
Create a new AdministrableProductDefinition
post
Search AdministrableProductDefinitions
post
Get AdministrableProductDefinition with identifier {identifier}
get
Update AdministrableProductDefinition with identifier {identifier}
put
Patch AdministrableProductDefinition with identifier {identifier}
patch
Delete AdministrableProductDefinition with identifier {identifier}
delete
Get history of AdministrableProductDefinition with identifier {identifier}
get
Get AdministrableProductDefinition with identifier {identifier} at version {versionIdentifier}
get
AdverseEvent
Search AdverseEvents
get
Create a new AdverseEvent
post
Search AdverseEvents
post
Get AdverseEvent with identifier {identifier}
get
Update AdverseEvent with identifier {identifier}
put
Patch AdverseEvent with identifier {identifier}
patch
Delete AdverseEvent with identifier {identifier}
delete
Get history of AdverseEvent with identifier {identifier}
get
Get AdverseEvent with identifier {identifier} at version {versionIdentifier}
get
AllergyIntolerance
Search AllergyIntolerances
get
Create a new AllergyIntolerance
post
Search AllergyIntolerances
post
Get AllergyIntolerance with identifier {identifier}
get
Update AllergyIntolerance with identifier {identifier}
put
Patch AllergyIntolerance with identifier {identifier}
patch
Delete AllergyIntolerance with identifier {identifier}
delete
Get history of AllergyIntolerance with identifier {identifier}
get
Get AllergyIntolerance with identifier {identifier} at version {versionIdentifier}
get
Appointment
Search Appointments
get
Create a new Appointment
post
Search Appointments
post
Get Appointment with identifier {identifier}
get
Update Appointment with identifier {identifier}
put
Patch Appointment with identifier {identifier}
patch
Delete Appointment with identifier {identifier}
delete
Get history of Appointment with identifier {identifier}
get
Get Appointment with identifier {identifier} at version {versionIdentifier}
get
AppointmentResponse
Search AppointmentResponses
get
Create a new AppointmentResponse
post
Search AppointmentResponses
post
Get AppointmentResponse with identifier {identifier}
get
Update AppointmentResponse with identifier {identifier}
put
Patch AppointmentResponse with identifier {identifier}
patch
Delete AppointmentResponse with identifier {identifier}
delete
Get history of AppointmentResponse with identifier {identifier}
get
Get AppointmentResponse with identifier {identifier} at version {versionIdentifier}
get
AuditEvent
Search AuditEvents
get
Create a new AuditEvent
post
Search AuditEvents
post
Get AuditEvent with identifier {identifier}
get
Update AuditEvent with identifier {identifier}
put
Patch AuditEvent with identifier {identifier}
patch
Delete AuditEvent with identifier {identifier}
delete
Get history of AuditEvent with identifier {identifier}
get
Get AuditEvent with identifier {identifier} at version {versionIdentifier}
get
Basic
Search Basics
get
Create a new Basic
post
Search Basics
post
Get Basic with identifier {identifier}
get
Update Basic with identifier {identifier}
put
Patch Basic with identifier {identifier}
patch
Delete Basic with identifier {identifier}
delete
Get history of Basic with identifier {identifier}
get
Get Basic with identifier {identifier} at version {versionIdentifier}
get
Binary
Search Binarys
get
Create a new Binary
post
Search Binarys
post
Get Binary with identifier {identifier}
get
Update Binary with identifier {identifier}
put
Patch Binary with identifier {identifier}
patch
Delete Binary with identifier {identifier}
delete
Get history of Binary with identifier {identifier}
get
Get Binary with identifier {identifier} at version {versionIdentifier}
get
BiologicallyDerivedProduct
Search BiologicallyDerivedProducts
get
Create a new BiologicallyDerivedProduct
post
Search BiologicallyDerivedProducts
post
Get BiologicallyDerivedProduct with identifier {identifier}
get
Update BiologicallyDerivedProduct with identifier {identifier}
put
Patch BiologicallyDerivedProduct with identifier {identifier}
patch
Delete BiologicallyDerivedProduct with identifier {identifier}
delete
Get history of BiologicallyDerivedProduct with identifier {identifier}
get
Get BiologicallyDerivedProduct with identifier {identifier} at version {versionIdentifier}
get
BodyStructure
Search BodyStructures
get
Create a new BodyStructure
post
Search BodyStructures
post
Get BodyStructure with identifier {identifier}
get
Update BodyStructure with identifier {identifier}
put
Patch BodyStructure with identifier {identifier}
patch
Delete BodyStructure with identifier {identifier}
delete
Get history of BodyStructure with identifier {identifier}
get
Get BodyStructure with identifier {identifier} at version {versionIdentifier}
get
Bundle
Search Bundles
get
Create a new Bundle
post
Search Bundles
post
Get Bundle with identifier {identifier}
get
Update Bundle with identifier {identifier}
put
Patch Bundle with identifier {identifier}
patch
Delete Bundle with identifier {identifier}
delete
Get history of Bundle with identifier {identifier}
get
Get Bundle with identifier {identifier} at version {versionIdentifier}
get
CapabilityStatement
Search CapabilityStatements
get
Create a new CapabilityStatement
post
Search CapabilityStatements
post
Get CapabilityStatement with identifier {identifier}
get
Update CapabilityStatement with identifier {identifier}
put
Patch CapabilityStatement with identifier {identifier}
patch
Delete CapabilityStatement with identifier {identifier}
delete
Get history of CapabilityStatement with identifier {identifier}
get
Get CapabilityStatement with identifier {identifier} at version {versionIdentifier}
get
CarePlan
Search CarePlans
get
Create a new CarePlan
post
Search CarePlans
post
Get CarePlan with identifier {identifier}
get
Update CarePlan with identifier {identifier}
put
Patch CarePlan with identifier {identifier}
patch
Delete CarePlan with identifier {identifier}
delete
Get history of CarePlan with identifier {identifier}
get
Get CarePlan with identifier {identifier} at version {versionIdentifier}
get
CareTeam
Search CareTeams
get
Create a new CareTeam
post
Search CareTeams
post
Get CareTeam with identifier {identifier}
get
Update CareTeam with identifier {identifier}
put
Patch CareTeam with identifier {identifier}
patch
Delete CareTeam with identifier {identifier}
delete
Get history of CareTeam with identifier {identifier}
get
Get CareTeam with identifier {identifier} at version {versionIdentifier}
get
CatalogEntry
Search CatalogEntrys
get
Create a new CatalogEntry
post
Search CatalogEntrys
post
Get CatalogEntry with identifier {identifier}
get
Update CatalogEntry with identifier {identifier}
put
Patch CatalogEntry with identifier {identifier}
patch
Delete CatalogEntry with identifier {identifier}
delete
Get history of CatalogEntry with identifier {identifier}
get
Get CatalogEntry with identifier {identifier} at version {versionIdentifier}
get
ChargeItem
Search ChargeItems
get
Create a new ChargeItem
post
Search ChargeItems
post
Get ChargeItem with identifier {identifier}
get
Update ChargeItem with identifier {identifier}
put
Patch ChargeItem with identifier {identifier}
patch
Delete ChargeItem with identifier {identifier}
delete
Get history of ChargeItem with identifier {identifier}
get
Get ChargeItem with identifier {identifier} at version {versionIdentifier}
get
ChargeItemDefinition
Search ChargeItemDefinitions
get
Create a new ChargeItemDefinition
post
Search ChargeItemDefinitions
post
Get ChargeItemDefinition with identifier {identifier}
get
Update ChargeItemDefinition with identifier {identifier}
put
Patch ChargeItemDefinition with identifier {identifier}
patch
Delete ChargeItemDefinition with identifier {identifier}
delete
Get history of ChargeItemDefinition with identifier {identifier}
get
Get ChargeItemDefinition with identifier {identifier} at version {versionIdentifier}
get
Citation
Search Citations
get
Create a new Citation
post
Search Citations
post
Get Citation with identifier {identifier}
get
Update Citation with identifier {identifier}
put
Patch Citation with identifier {identifier}
patch
Delete Citation with identifier {identifier}
delete
Get history of Citation with identifier {identifier}
get
Get Citation with identifier {identifier} at version {versionIdentifier}
get
Claim
Search Claims
get
Create a new Claim
post
Search Claims
post
Get Claim with identifier {identifier}
get
Update Claim with identifier {identifier}
put
Patch Claim with identifier {identifier}
patch
Delete Claim with identifier {identifier}
delete
Get history of Claim with identifier {identifier}
get
Get Claim with identifier {identifier} at version {versionIdentifier}
get
ClaimResponse
Search ClaimResponses
get
Create a new ClaimResponse
post
Search ClaimResponses
post
Get ClaimResponse with identifier {identifier}
get
Update ClaimResponse with identifier {identifier}
put
Patch ClaimResponse with identifier {identifier}
patch
Delete ClaimResponse with identifier {identifier}
delete
Get history of ClaimResponse with identifier {identifier}
get
Get ClaimResponse with identifier {identifier} at version {versionIdentifier}
get
ClinicalImpression
Search ClinicalImpressions
get
Create a new ClinicalImpression
post
Search ClinicalImpressions
post
Get ClinicalImpression with identifier {identifier}
get
Update ClinicalImpression with identifier {identifier}
put
Patch ClinicalImpression with identifier {identifier}
patch
Delete ClinicalImpression with identifier {identifier}
delete
Get history of ClinicalImpression with identifier {identifier}
get
Get ClinicalImpression with identifier {identifier} at version {versionIdentifier}
get
ClinicalUseDefinition
Search ClinicalUseDefinitions
get
Create a new ClinicalUseDefinition
post
Search ClinicalUseDefinitions
post
Get ClinicalUseDefinition with identifier {identifier}
get
Update ClinicalUseDefinition with identifier {identifier}
put
Patch ClinicalUseDefinition with identifier {identifier}
patch
Delete ClinicalUseDefinition with identifier {identifier}
delete
Get history of ClinicalUseDefinition with identifier {identifier}
get
Get ClinicalUseDefinition with identifier {identifier} at version {versionIdentifier}
get
CodeSystem
Search CodeSystems
get
Create a new CodeSystem
post
Search CodeSystems
post
Get CodeSystem with identifier {identifier}
get
Update CodeSystem with identifier {identifier}
put
Patch CodeSystem with identifier {identifier}
patch
Delete CodeSystem with identifier {identifier}
delete
Get history of CodeSystem with identifier {identifier}
get
Get CodeSystem with identifier {identifier} at version {versionIdentifier}
get
Communication
Search Communications
get
Create a new Communication
post
Search Communications
post
Get Communication with identifier {identifier}
get
Update Communication with identifier {identifier}
put
Patch Communication with identifier {identifier}
patch
Delete Communication with identifier {identifier}
delete
Get history of Communication with identifier {identifier}
get
Get Communication with identifier {identifier} at version {versionIdentifier}
get
CommunicationRequest
Search CommunicationRequests
get
Create a new CommunicationRequest
post
Search CommunicationRequests
post
Get CommunicationRequest with identifier {identifier}
get
Update CommunicationRequest with identifier {identifier}
put
Patch CommunicationRequest with identifier {identifier}
patch
Delete CommunicationRequest with identifier {identifier}
delete
Get history of CommunicationRequest with identifier {identifier}
get
Get CommunicationRequest with identifier {identifier} at version {versionIdentifier}
get
CompartmentDefinition
Search CompartmentDefinitions
get
Create a new CompartmentDefinition
post
Search CompartmentDefinitions
post
Get CompartmentDefinition with identifier {identifier}
get
Update CompartmentDefinition with identifier {identifier}
put
Patch CompartmentDefinition with identifier {identifier}
patch
Delete CompartmentDefinition with identifier {identifier}
delete
Get history of CompartmentDefinition with identifier {identifier}
get
Get CompartmentDefinition with identifier {identifier} at version {versionIdentifier}
get
Composition
Search Compositions
get
Create a new Composition
post
Search Compositions
post
Get Composition with identifier {identifier}
get
Update Composition with identifier {identifier}
put
Patch Composition with identifier {identifier}
patch
Delete Composition with identifier {identifier}
delete
Get history of Composition with identifier {identifier}
get
Get Composition with identifier {identifier} at version {versionIdentifier}
get
ConceptMap
Search ConceptMaps
get
Create a new ConceptMap
post
Search ConceptMaps
post
Get ConceptMap with identifier {identifier}
get
Update ConceptMap with identifier {identifier}
put
Patch ConceptMap with identifier {identifier}
patch
Delete ConceptMap with identifier {identifier}
delete
Get history of ConceptMap with identifier {identifier}
get
Get ConceptMap with identifier {identifier} at version {versionIdentifier}
get
Condition
Search Conditions
get
Create a new Condition
post
Search Conditions
post
Get Condition with identifier {identifier}
get
Update Condition with identifier {identifier}
put
Patch Condition with identifier {identifier}
patch
Delete Condition with identifier {identifier}
delete
Get history of Condition with identifier {identifier}
get
Get Condition with identifier {identifier} at version {versionIdentifier}
get
Consent
Search Consents
get
Create a new Consent
post
Search Consents
post
Get Consent with identifier {identifier}
get
Update Consent with identifier {identifier}
put
Patch Consent with identifier {identifier}
patch
Delete Consent with identifier {identifier}
delete
Get history of Consent with identifier {identifier}
get
Get Consent with identifier {identifier} at version {versionIdentifier}
get
Contract
Search Contracts
get
Create a new Contract
post
Search Contracts
post
Get Contract with identifier {identifier}
get
Update Contract with identifier {identifier}
put
Patch Contract with identifier {identifier}
patch
Delete Contract with identifier {identifier}
delete
Get history of Contract with identifier {identifier}
get
Get Contract with identifier {identifier} at version {versionIdentifier}
get
Coverage
Search Coverages
get
Create a new Coverage
post
Search Coverages
post
Get Coverage with identifier {identifier}
get
Update Coverage with identifier {identifier}
put
Patch Coverage with identifier {identifier}
patch
Delete Coverage with identifier {identifier}
delete
Get history of Coverage with identifier {identifier}
get
Get Coverage with identifier {identifier} at version {versionIdentifier}
get
CoverageEligibilityRequest
Search CoverageEligibilityRequests
get
Create a new CoverageEligibilityRequest
post
Search CoverageEligibilityRequests
post
Get CoverageEligibilityRequest with identifier {identifier}
get
Update CoverageEligibilityRequest with identifier {identifier}
put
Patch CoverageEligibilityRequest with identifier {identifier}
patch
Delete CoverageEligibilityRequest with identifier {identifier}
delete
Get history of CoverageEligibilityRequest with identifier {identifier}
get
Get CoverageEligibilityRequest with identifier {identifier} at version {versionIdentifier}
get
CoverageEligibilityResponse
Search CoverageEligibilityResponses
get
Create a new CoverageEligibilityResponse
post
Search CoverageEligibilityResponses
post
Get CoverageEligibilityResponse with identifier {identifier}
get
Update CoverageEligibilityResponse with identifier {identifier}
put
Patch CoverageEligibilityResponse with identifier {identifier}
patch
Delete CoverageEligibilityResponse with identifier {identifier}
delete
Get history of CoverageEligibilityResponse with identifier {identifier}
get
Get CoverageEligibilityResponse with identifier {identifier} at version {versionIdentifier}
get
DetectedIssue
Search DetectedIssues
get
Create a new DetectedIssue
post
Search DetectedIssues
post
Get DetectedIssue with identifier {identifier}
get
Update DetectedIssue with identifier {identifier}
put
Patch DetectedIssue with identifier {identifier}
patch
Delete DetectedIssue with identifier {identifier}
delete
Get history of DetectedIssue with identifier {identifier}
get
Get DetectedIssue with identifier {identifier} at version {versionIdentifier}
get
Device
Search Devices
get
Create a new Device
post
Search Devices
post
Get Device with identifier {identifier}
get
Update Device with identifier {identifier}
put
Patch Device with identifier {identifier}
patch
Delete Device with identifier {identifier}
delete
Get history of Device with identifier {identifier}
get
Get Device with identifier {identifier} at version {versionIdentifier}
get
DeviceDefinition
Search DeviceDefinitions
get
Create a new DeviceDefinition
post
Search DeviceDefinitions
post
Get DeviceDefinition with identifier {identifier}
get
Update DeviceDefinition with identifier {identifier}
put
Patch DeviceDefinition with identifier {identifier}
patch
Delete DeviceDefinition with identifier {identifier}
delete
Get history of DeviceDefinition with identifier {identifier}
get
Get DeviceDefinition with identifier {identifier} at version {versionIdentifier}
get
DeviceMetric
Search DeviceMetrics
get
Create a new DeviceMetric
post
Search DeviceMetrics
post
Get DeviceMetric with identifier {identifier}
get
Update DeviceMetric with identifier {identifier}
put
Patch DeviceMetric with identifier {identifier}
patch
Delete DeviceMetric with identifier {identifier}
delete
Get history of DeviceMetric with identifier {identifier}
get
Get DeviceMetric with identifier {identifier} at version {versionIdentifier}
get
DeviceRequest
Search DeviceRequests
get
Create a new DeviceRequest
post
Search DeviceRequests
post
Get DeviceRequest with identifier {identifier}
get
Update DeviceRequest with identifier {identifier}
put
Patch DeviceRequest with identifier {identifier}
patch
Delete DeviceRequest with identifier {identifier}
delete
Get history of DeviceRequest with identifier {identifier}
get
Get DeviceRequest with identifier {identifier} at version {versionIdentifier}
get
DeviceUseStatement
Search DeviceUseStatements
get
Create a new DeviceUseStatement
post
Search DeviceUseStatements
post
Get DeviceUseStatement with identifier {identifier}
get
Update DeviceUseStatement with identifier {identifier}
put
Patch DeviceUseStatement with identifier {identifier}
patch
Delete DeviceUseStatement with identifier {identifier}
delete
Get history of DeviceUseStatement with identifier {identifier}
get
Get DeviceUseStatement with identifier {identifier} at version {versionIdentifier}
get
DiagnosticReport
Search DiagnosticReports
get
Create a new DiagnosticReport
post
Search DiagnosticReports
post
Get DiagnosticReport with identifier {identifier}
get
Update DiagnosticReport with identifier {identifier}
put
Patch DiagnosticReport with identifier {identifier}
patch
Delete DiagnosticReport with identifier {identifier}
delete
Get history of DiagnosticReport with identifier {identifier}
get
Get DiagnosticReport with identifier {identifier} at version {versionIdentifier}
get
