Lab Network iFrame
The Lab Network iFrame provides an embedded ordering experience that allows users to place diagnostic orders within your application using the Lab Network ordering interface.
Embedded order entry allows order placement for laboratory and other supported diagnostic services without requiring a custom ordering UI. The iFrame does not support result display or retrieval.
Ordering Capabilities
The primary function of the iFrame is embedded order entry.
Through the iFrame, users can:
- Place diagnostic orders within your application workflow
- Select the ordering facility and ordering provider
- Confirm patient context
- Choose requested tests based on configured compendia
Orders placed through the iFrame follow the same validation, compendium alignment, routing, and fulfillment rules as API-based or UI-based orders.
Prerequisites
iFrame access requires:
- An enabled Lab Network tenant
- Configured laboratory connections and compendium alignment
- OAuth 2.0 credentials with appropriate ordering scopes
The iFrame uses the same underlying Lab Network configuration as API-based ordering, including routing rules and test catalog alignment.
The iFrame does not require FHIR integration for order placement. Results handling requires API-based access or use of the UI.
Implementation
iFrame implementation involves:
- Enabling Lab Network and required laboratory connections
- Configuring OAuth 2.0 credentials with appropriate scopes
- Implementing the iFrame launch flow within your application
The iFrame session is created by calling the Lab Network iFrame API, which returns an order-entry URL to launch the embedded session.
The session is created for a specific patient, by providing either patient demographics or an existing Health Gorilla patient ID. Using an existing patient ID ensures an exact match. When demographics are provided, patient matching rules are applied and a new patient may be created if no match is found.
Orders are placed through the embedded interface and follow the same validation, routing, and fulfillment behavior as API-based orders.
iFrame Request Example
The following example shows a minimal request used to create an iFrame session.
{
"jsonrpc": "2.0",
"method": "placeOrder",
"params": [
{
"facilityType": "DiagnosticLaboratories",
"callbackUrl": "https://yourapp.com/callback",
"patient": {
"className": "com.informedika.common.shared.vo.PatientVO",
"firstName": "Jane",
"lastName": "Doe",
"gender": "female",
"dateOfBirth": {
"year": 1990,
"month": 1,
"day": 1
}
}
}
]
}
The response includes a callback URL. Append the OAuth access token and launch the resulting URL in an embedded frame or browser window.
Session Scope And Authentication
The iFrame uses OAuth 2.0 authentication.
Your system must:
- Obtain an access token
- Launch the iFrame using the URL returned by the ordering workflow
Each session is scoped to a single patient and a single order.
The session does not provide access to:
- Other patients
- Order history
- Administrative functionality
Ordering Flow
Ordering through the iFrame follows a defined interaction between your application and Lab Network:
- Your system initiates an order request
- Lab Network returns an order-entry URL
- Your application launches the URL in an embedded frame or browser window
- The user completes or cancels the order
- Control returns to your application
The patient context is resolved before the order-entry session is created.
Results Handling
The iFrame does not display or provide access to results.
Handle results from iFrame orders through:
- API-based access for structured or document-based results
- Operational review in the UI
Limitations
The iFrame is limited to order placement and does not support:
- Structured result retrieval
- Document-based result retrieval
- Longitudinal result viewing
- Downstream data ingestion
Automated workflows, analytics, and clinical integration require API-based access.
Relationship To Other Access Models
The iFrame complements API and UI access models:
- API access supports structured results retrieval and automation
- The UI supports manual ordering and operational review
- The iFrame supports embedded order placement
These models are often used together within a single implementation.
Updated about 17 hours ago
