Aidbox User Docs
Run Aidbox locallyRun Aidbox in SandboxTalk to us Ask community
  • Aidbox FHIR platform documentation
    • Features
    • Architecture
  • Getting Started
    • Run Aidbox in Sandbox
    • Run Aidbox locally
    • Run Aidbox on AWS
    • Upload Sample Data
  • Tutorials
    • CRUD, Search Tutorials
      • Delete data
      • Set up uniqueness in Resource
      • Search Tutorials
        • Custom SearchParameter tutorial
        • Create custom Aidbox Search resource
        • Multilingual search tutorial
        • Migrate from Aidbox SearchParameter to FHIR SearchParameter
        • Change sort order by locale collation
    • Bulk API Tutorials
      • 🎓Synthea by Bulk API
      • 🎓$dump-sql tutorial
    • Security & Access Control Tutorials
      • Allow patients to see their own data
      • Restrict operations on resource type
      • Relationship-based access control
      • Creating user & set up full user access
      • Restricting Access to Patient Data
      • Create and test access control
      • RBAC
        • Flexible RBAC built-in to Aidbox
        • RBAC with JWT containing role
        • RBAC with ACL
      • Set-up token introspection
      • Prohibit user to login
      • Managing Admin Access to the Aidbox UI Using Okta Groups
      • Run Multibox locally
      • How to enable labels-based access control
      • How to enable patient data access API
      • How to enable SMART on FHIR on Patient Access API
      • How to enable hierarchical access control
      • How to configure Audit Log
      • How is an HTTP request processed in Aidbox
      • How to configure SSO with another Aidbox instance to access Aidbox UI
      • How to configure SSO with Okta to access Aidbox UI
      • How to configure sign-in with Apple for access to the Aidbox UI
      • How to configure Azure AD SSO for access to the Aidbox UI
      • How to configure Microsoft AD FS for access to the Aidbox UI
      • How to configure Azure AD SSO with certificate authentication for access to the Aidbox UI
      • How to configure GitHub SSO for access to Aidbox UI
      • How to configure Keycloak for access for AidboxUI
      • How to implement Consent-based Access Control using FHIR Search and Aidbox Access Policy
      • Debug Access Control
      • AccessPolicy best practices
    • Terminology Tutorials
      • Load ICD-10 terminology into Aidbox
      • Uploading IG terminology content to external FHIR terminology server
    • Validation Tutorials
      • Upload FHIR Implementation Guide
        • Environment Variable
        • Aidbox UI
          • IG Package from Aidbox Registry
          • Public URL to IG Package
          • Local IG Package
        • Aidbox FHIR API
        • UploadFIG Tool
      • ISiK
      • Carin BB
      • US Core
      • Davinci Pdex
      • mCode
    • Integration Toolkit Tutorials
      • Postmark integration tutorial
      • Mailgun integration tutorial
    • Subscriptions Tutorials
      • AidboxTopicSubscription NATS tutorial
    • Other tutorials
      • Run Aidbox with FHIR R6
      • Migrate from Multibox to Aidbox
      • SDC with Custom Resources
      • How to create FHIR NPM package
      • Migrate from legacy licence portal to Aidbox portal
      • How to run Aidbox in GCP Cloud Run
  • Overview
    • Licensing and Support
    • Aidbox user portal
      • Projects
      • Licenses
      • Members
    • Aidbox UI
      • Aidbox Notebooks
      • REST Console
      • Database Console
      • Attrs stats
      • DB Tables
      • DB Queries
    • Versioning
    • Release Notes
    • Contact us
  • Configuration
    • Settings
    • Configure Aidbox and Multibox
    • Init Bundle
  • API
    • REST API
      • CRUD
        • Create
        • Read
        • Update
        • Patch
        • Delete
      • FHIR Search
        • SearchParameter
        • Include and Revinclude
        • Chaining
      • Aidbox Search
      • Bundle
      • History
      • $everything on Patient
      • Other
        • Aidbox & FHIR formats
        • Capability Statement
        • $document
        • Observation/$lastn
        • $validate
        • SQL endpoints
        • $matcho
        • $to-format
        • Aidbox version
        • Health check
    • Bulk API
      • Configure Access Policies for Bulk API
      • $dump
      • $dump-sql
      • $dump-csv
      • $export
      • $load & /fhir/$load
      • $import & /fhir/$import
      • aidbox.bulk data import
      • Bulk import from an S3 bucket
    • Batch/Transaction
    • GraphQL API
    • Other APIs
      • Plan API
        • Provider Directory API
          • Practitioner
          • PractitionerRole
          • Organization
          • OrganizationAffiliation
        • Plan API Overview
      • Archive/Restore API
        • create-archive
        • restore-archive
        • prune-archived-data
        • delete-archive
      • ETAG support
      • Cache
      • Changes API
      • RPC API
      • Sequence API
      • Encryption API
      • Batch Upsert
  • Modules
    • Profiling and validation
      • FHIR Schema Validator
        • Aidbox FHIR IGs Registry
        • Setup Aidbox with FHIR Schema validation engine
      • Skip validation of references in resource using request header
      • Asynchronous resource validation
    • Access Control
      • Identity Management
        • User Management
        • Application/Client Management
      • Authentication
        • Basic HTTP Authentication
        • OAuth 2.0
        • Token Introspector
        • SSO with External Identity Provider
      • Authorization
        • Access Policies
        • SMART on FHIR
          • SMART Client Authorization
            • SMART App Launch
            • SMART Backend services
          • SMART Client Authentication
            • SMART: Asymmetric (/"private key JWT") authentication
            • SMART: Symmetric (/"client secret") authentication
          • SMART: Scopes for Limiting Access
          • Pass Inferno tests with Aidbox
          • Example: SMART App Launch using Aidbox and Keycloak
          • Example: SMART App Launch using Smartbox and Keycloak
        • Scoped API
          • Organization-based hierarchical access control
          • Compartments API
          • Patient data access API
        • Label-based Access Control
      • Audit & Logging
    • Observability
      • Getting started
        • Run Aidbox with OpenTelemetry locally
        • How to export telemetry to the OTEL collector
      • Logs
        • How-to guides
          • OpenTelemetry logs
          • Elastic Logs and Monitoring Integration
          • Datadog Log management integration
          • Loki Log management integration
        • Tutorials
          • Log analysis and visualization tutorial
          • Export logs to Datadog tutorial
        • Extending Aidbox Logs
        • Technical reference
          • Log appenders
          • Log transformations
          • Log Schema
          • OTEL logs exporter parameters
      • Metrics
        • How-to guides
          • How to export metrics to the OTEL collector
          • Use Aidbox Metrics Server
          • Set-up Grafana integration
        • Technical reference
          • OpenTelemetry Metrics
          • OTEL metrics exporter parameters
      • Traces
        • How to use tracing
        • OTEL traces exporter parameters
    • Subscriptions
      • Aidbox topic-based subscriptions
        • Kafka AidboxTopicDestination
        • Webhook AidboxTopicDestination
        • GCP Pub/Sub AidboxTopicDestination
        • Tutorial: produce QuestionnaireResponse to Kafka topic
      • Aidbox SubSubscriptions
    • Aidbox Forms
      • Getting started
      • Aidbox Forms Interface
      • Aidbox UI Builder
        • UI Builder Interface
        • Form creation
          • Form Settings
          • Widgets
          • Components
          • Versioning
          • Form customisation in Theme Editor
          • Form signature
          • How-to guides
            • How to: populate forms with data
            • How to extract data from forms
            • How to calculate form filling percentage
          • Multilingual forms
          • FHIRPath Editor
        • Import Questionnaire
        • Form sharing
        • Printing forms
          • Template-based PDF generation
        • FHIR versions
        • Offline forms
        • Embedding
          • Request Interception
        • Configuration
        • Forms multitenancy
        • Building reports using SQL on FHIR
        • Integration with external terminology servers
        • External FHIR servers as a data backend
        • Store attachments in S3-like storages
      • Access Control in Forms
      • Audit Logging in Forms
      • Aidbox Form Gallery
    • Define extensions
      • Extensions using StructureDefinition
      • Extensions using FHIRSchema
    • Custom Resources
      • Custom resources using FHIR Schema
      • Custom resources using StructureDefinition
      • Migrate to FHIR Schema
        • Migrate custom resources defined with Entity & Attributes to FHIR Schema
        • Migrate custom resources defined with Zen to FHIR Schema
    • Aidbox terminology module
      • Concept
        • $translate-concepts
        • Handling hierarchies using ancestors
      • ValueSet
        • ValueSet Expansion
        • ValueSet Code Validation
        • Create a ValueSet
      • CodeSystem
        • CodeSystem Concept Lookup
        • CodeSystem Subsumption testing
        • CodeSystem Code Composition
      • Import external terminologies
        • Import flat file (/CSV)
        • $import operation
        • Ready-to-use terminologies
      • $translate on ConceptMap
    • SQL on FHIR
      • Defining flat views with View Definitions
      • Query data from flat views
      • Reference
    • Integration toolkit
      • C-CDA / FHIR Converter
        • List of supported templates
          • Admission Diagnosis Section (/V3)
          • Advance Directives Section (/entries optional) (/V3)
          • Advance Directives Section (/entries required) (/V3)
          • Allergies and Intolerances Section (/entries optional) (/V3)
          • Allergies and Intolerances Section (/entries required) (/V3)
          • Assessment Section
          • Chief Complaint Section
          • Chief Complaint and Reason for Visit Section
          • Complications Section (/V3)
          • Course of Care Section
          • DICOM Object Catalog Section - DCM 121181
          • Default Section Rules
          • Discharge Diagnosis Section (/V3)
          • Document Header
          • Encounters Section (/entries optional) (/V3)
          • Encounters Section (/entries required) (/V3)
          • Family History Section (/V3)
          • Functional Status Section (/V2)
          • General Status Section
          • Goals Section
          • Health Concerns Section (/V2)
          • History of Present Illness Section
          • Hospital Consultations Section
          • Hospital Course Section
          • Hospital Discharge Instructions Section
          • Hospital Discharge Physical Section
          • Hospital Discharge Studies Summary Section
          • Immunizations Section (/entries optional) (/V3)
          • Immunizations Section (/entries required) (/V3)
          • Medical (/General) History Section
          • Medical Equipment Section (/V2)
          • Medications Administered Section (/V2)
          • Medications Section (/entries optional) (/V2)
          • Medications Section (/entries required) (/V2)
          • Mental Status Section (/V2)
          • Notes
          • Nutrition Section
          • Objective Section
          • Operative Note Fluids Section
          • Operative Note Surgical Procedure Section
          • Past Medical History (/V3)
          • Payers Section (/V3)
          • Plan of Treatment Section (/V2)
          • Postprocedure Diagnosis Section (/V3)
          • Preoperative Diagnosis Section (/V3)
          • Problem Section (/entries optional) (/V3)
          • Problem Section (/entries required) (/V3)
          • Procedure Description Section
          • Procedure Disposition Section
          • Procedure Estimated Blood Loss Section
          • Procedure Implants Section
          • Procedure Specimens Taken Section
          • Procedures Section (/entries optional) (/V2)
          • Procedures Section (/entries required) (/V2)
          • Reason for Visit Section
          • Results Section (/entries optional) (/V3)
          • Results Section (/entries required) (/V3)
          • Review of Systems Section
          • Social History Section (/V3)
          • Vital Signs Section (/entries optional) (/V3)
          • Vital Signs Section (/entries required) (/V3)
        • How to deploy the service
        • Producing C-CDA documents
        • How to customize conversion rules
      • HL7 v2 Integration
        • HL7 v2 integration with Aidbox Project
        • Mappings with lisp/mapping
      • X12 message converter
      • Analytics
        • Power BI
      • Mappings
      • Email Providers integration
        • Setup SMTP provider
    • SMARTbox | FHIR API for EHRs
      • Get started
        • Set up Smartbox locally
        • Deploy Smartbox with Kubernetes
      • (/g)(/10) Standardized API for patient and population services
      • The B11 Decision Support Interventions
        • Source attributes
        • Feedback Sections
      • How-to guides
        • Pass Inferno tests with Smartbox
        • Perform EHR launch
        • Pass Inferno Visual Inspection and Attestation
        • Revoke granted access
        • Set up EHR-level customization
        • Check email templates
        • Setup email provider
        • Register users
        • Set up SSO with Auth0
        • Publish Terms of Use link onto the documentation page
        • Find out what resources were exported during the $export operation
        • Find documentation endpoint
      • Background information
        • Considerations for Testing with Inferno ONC
        • Adding Clients for Inferno tests
        • Multitenancy approach
        • What is Tenant
        • Email templating
    • ePrescription
      • Getting started
      • Authentication with mTLS
      • Pharmacies synchronization
      • Prescribing
        • NewRx Message
        • CancelRx Message
        • How to test Callback
      • Directory
        • DirectoryDownload Message
        • GetProviderLocation Message
        • AddProviderLocation Message
        • UpdateProviderLocation Message
        • DisableProviderLocation Message
      • Medications
        • FDB
      • References
        • Environment Variables
      • Frequently Asked Questions
    • Other modules
      • MDM
        • Train model
        • Configure MDM module
        • Find duplicates: $match
        • Mathematical details
      • MCP
  • Database
    • Overview
    • Database schema
    • PostgreSQL Extensions
    • AidboxDB
      • HA AidboxDB
    • Tutorials
      • Migrate to AidboxDB 16
      • Working with pgAgent
  • File storage
    • AWS S3
    • GCP Cloud Storage
    • Azure Blob Storage
    • Oracle Cloud Storage
  • Deployment and maintenance
    • Deploy Aidbox
      • Run Aidbox on Kubernetes
        • Deploy Production-ready Aidbox to Kubernetes
        • Deploy Aidbox with Helm Charts
        • Highly Available Aidbox
        • Self-signed SSL certificates
      • Run Aidbox on managed PostgreSQL
      • How to inject env variables into Init Bundle
    • Backup and Restore
      • Crunchy Operator (/pgBackRest)
      • pg_dump
      • pg_basebackup
      • WAL-G
    • Indexes
      • Get suggested indexes
      • Create indexes manually
  • App development
    • Use Aidbox with React
    • Aidbox SDK
      • Aidbox JavaScript SDK
      • Apps
      • NodeJs SDK
      • Python SDK
    • Examples
  • Reference
    • Matcho DSL reference
    • FHIR Schema reference
    • Settings reference
      • General
      • FHIR
      • Security & Access Control
      • Modules
      • Database
      • Web Server
      • Observability
      • Zen Project
    • Environment variables
      • Aidbox required environment variables
      • Optional environment variables
      • AidboxDB environment variables
    • System resources reference
      • IAM Module Resources
      • SDC Module Resources
      • Base Module Resources
      • Bulk Module Resources
      • AWF Module Resources
      • Cloud Module Resources
      • HL7v2 Module Resources
      • SQL on FHIR Module Resources
    • Email Providers reference
      • Notification resource reference
      • Mailgun environment variables
      • Postmark environment variables
    • Aidbox Forms reference
      • FHIR SDC API
      • Aidbox SDC API
      • Generating Questionnaire from PDF API
    • Aidbox SQL functions
  • Deprecated
    • Deprecated
      • Zen-related
        • RPC reference
          • aidbox
            • mdm
              • aidbox.mdm/update-mdm-tables
              • aidbox.mdm/match
        • FTR
        • Aidbox configuration project
          • Run Aidbox locally using Aidbox Configuraiton project
          • Aidbox configuration project structure
          • Set up and use configuration projects
          • Enable IGs
          • Repository
          • Seed Import
          • Manage Indexes in Zen Project
          • Seed v2
          • 🎓Migrate to git Aidbox Configuration Projects
          • Aidbox Configuration project reference
            • Zen Configuration
            • Aidbox project RPC reference
            • aidbox.config/config
          • Custom resources using Aidbox Project
          • First-Class Extensions using Zen
          • Zen Indexes
        • US Core IG
          • US Core IG support reference
        • Workflow Engine
          • Task
            • Aidbox Built-in Tasks
            • Task Executor API
            • Task User API
          • Workflow
            • Workflow User API
          • Services
          • Monitoring
        • FHIR conformance Deprecated guides
          • Touchstone FHIR 4.0.1 basic server
          • Touchstone FHIR USCore ClinData
          • How to enable US Core IG
            • Start Aidbox locally with US Core IG enabled
            • Add US Core IG to a running Aidbox instance
          • HL7 FHIR Da Vinci PDex Plan Net IG
        • Terminology Deprecated Tutorials
          • Inferno Test-Suite US Core 3.1.1
        • API constructor (/beta)
        • zen-lang validator
          • Write a custom zen profile
          • Load zen profiles into Aidbox
        • FHIR topic-based subscriptions
          • Set up SubscriptionTopic
          • Tutorial: Subscribe to Topic (/R4B)
          • API Reference
            • Subscription API
        • 🏗️FHIR Terminology Repository
          • FTR Specification
          • Create an FTR instance
            • FTR from CSV
            • FTR from FHIR IG
            • FTR from FTR — Direct Dependency
            • FTR from FTR — Supplement
          • FTR Manifest
          • Load SNOMED CT into Aidbox
          • Load LOINC into Aidbox
          • Load ICD-10-CM into Aidbox
          • Load RxNorm into Aidbox
          • Load US VSAC Package to Aidbox
          • Import via FTR
        • Zen Search Parameters
      • Entity / Attribute
        • Entities & Attributes
        • First-Class Extensions using Attribute
        • Custom Resources using Entity
        • Working with Extensions
        • Aidbox Search Parameters
      • Forms
      • Other
        • Custom Search
        • SearchQuery
        • Subscribe to new Patient resource
        • App Development Deprecated Tutorials
          • Receive logs from your app
            • X-Audit header
          • Patient Encounter notification Application
        • Other Deprecated Tutorials
          • Resource generation with map-to-fhir-bundle-task and subscription triggers
          • APM Aidbox
          • Automatically archive AuditEvent resources in GCP storage guide
          • HL7 v2 pipeline with Patient mapping
          • How to migrate to Apline Linux
          • How to migrate transaction id to bigint
          • How to fix broken dates
          • Configure multi-tenancy
        • AidboxProfile
        • GCP Pub/Sub
Powered by GitBook
On this page
  • Warn
  • You should have items with types - that corresponds populate values types.
  • How to populate form with patient demographic data: patient name, DOB, MRN, address, phone
  • Form Setup (design time)
  • Populate Parameters (usage time)
  • How to populate form with patient weight, height
  • Form Setup (design time)
  • Populate parameters (usage time)
  • How to populate form with patient allergies
  • Form Setup (design time)
  • Populate parameters (usage time)
  • How to populate form with data from another form during the visit
  • Form Setup (design time)
  • Populate parameters (usage time)

Was this helpful?

Edit on GitHub
  1. Modules
  2. Aidbox Forms
  3. Aidbox UI Builder
  4. Form creation
  5. How-to guides

How to: populate forms with data

Warn

You should have items with types - that corresponds populate values types.

In all populate items configuration you should use proper item(widget) for populate data

Item
data type

String Input

string

Textarea

string

URL

url

Integer Input

integer

Decimal Input

decimal

Quantity Input

quantity

Date

date

Time

time

Datetime

dateTime

Choice Input

coding

Open Choice Input

coding/string

Radio Button

coding

Boolean input

boolean

File

attachment

Author's Signature

attachment

Reference

reference

How to populate form with patient demographic data: patient name, DOB, MRN, address, phone

To populate a form we should:

  1. setup a form to be able to get patient's data and prefill form items with it (design time)

  2. provide patient's reference to population operation. (usage time)

Form Setup (design time)

Assume that we already have:

  • form with 5 items(data: patient name, DOB, MRN, address, phone)

  • Patient resource in the Aidbox DB

Patient resource example:

resourceType: Patient
id: example
gender: male
name:
- family: Chalmers
  given:
  - Peter
  - James
address:
- city: PleasantVille
  district: Rainbow
  postalCode: '3999'
  text: 534 Erewhon St PeasantVille, Rainbow, Vic  3999
  line:
  - 534 Erewhon St
  state: Vic
identifier:
- use: usual
  type:
    coding:
    - system: http://terminology.hl7.org/CodeSystem/v2-0203
      code: MR
  system: urn:oid:1.2.36.146.595.217.0.1
  value: '12345'
birthDate: '1974-12-25'
telecom:
- system: phone
  value: (03) 5555 6473

We should setup items with populate expressions.

How to find population expression:

  1. select widget in the outline 2 click on populate checkbox in the widget settings panel

  2. in opened section select Expression tab

For this example we will use:

  • %subject parameter, which will contain Patient resource

  • FHIRPath expressions to retrieve data.

%subject parameter will be filled with data in population operation

Expressions:

Patient name

%subject.name.family + ' ' + %subject.name.given.first()

DOB (Date widget)

%subject.birthDate

MRN (Text widget)

%subject.identifier.where(type.coding.system='http://terminology.hl7.org/CodeSystem/v2-0203', type.coding.code='MR').value

address (Text widget)

%subject.address.text

phone (Text widget)

%subject.telecom.value

Populate Parameters (usage time)

To make %subject resource available we should call $populate operation with specific parameters

  • subject = <reference> (reference to patient)

  • local = true (says that we should search for subject in DB and load resource)

Operation call example:

POST /fhir/Questionnaire/<qid>/$populatelink

resourceType: Parameters
parameter:
- name: subject
  valueReference:
    reference: Patient/example
- name: local
  valueBoolean: true

How to populate form with patient weight, height

To populate a form we should:

  1. setup a form to be able to get patient's observations (design time)

  2. provide patient's reference to population operation. (usage time)

Form Setup (design time)

Assume that we have:

  • Form with body weight and body height items

  • Patient in DB

  • Patient's body weight and body height Observations in DB

Stored Observations should be linked to a patient and should be coded with right terminology code (LOINC in our example)

LOINC coding for body measurements:

  • Body Height: { system: http://loinc.org, code: 8302-2 }

  • Body Weight: { system: http://loinc.org, code: 29463-7 }

Observation examples

Body Weight

resourceType: Observation
subject:
  reference: Patient/example
status: final
code:
  coding:
  - code: 29463-7
    system: http://loinc.org
valueQuantity:
  unit: kg
  value: 80

Body Height

resourceType: Observation
subject:
  reference: Patient/example
status: final
code:
  coding:
  - code: 8302-2
    system: http://loinc.org
valueQuantity:
  unit: cm
  value: 180

We should configure items with Observation based population

  1. Select item in outline

  2. Press include code? section and type corresponding code/system (from Observations)

  3. Enable Populate section (Observation population should be opened by default) and choose period to search for Observations. (For example 1 Month)

Populate parameters (usage time)

To pass Patient's reference we use subject parameter to $populatelink/$populate operation.

Operation call example:

POST /fhir/Questionnaire/<qid>/$populatelink

resourceType: Parameters
parameter:
- name: subject
  valueReference:
    reference: Patient/example

How to populate form with patient allergies

To populate a form with data from allergies we should

  1. setup a form to be able to find allergies for a patient and populate them in a list (design time)

    • Create a group/group table with columns of proper types

    • Set named expression for created group to search for allergies

    • Set columns populate expressions to extract data from found AllergyIntolerance resources

  2. provide Patient reference in input parameters of populate operation (usage time)

Form Setup (design time)

Assume that we already have:

  • Form for Allergies

  • Several AllergyIntolerance resources in DB

AllergyIntolerance resource examples:

Food allergy

resourceType: AllergyIntolerance
id: example
type: allergy
patient:
  reference: Patient/pt-1
category:
- food
criticality: high
recordedDate: '2014-10-09T14:58:00+11:00'
onsetDateTime: '2004'
clinicalStatus:
  coding:
  - system: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
    code: active
    display: Active
lastOccurrence: 2012-06
reaction:
- substance:
    coding:
    - system: http://www.nlm.nih.gov/research/umls/rxnorm
      code: '1160593'
      display: cashew nut allergenic extract Injectable Product
  manifestation:
  - coding:
    - system: http://snomed.info/sct
      code: '39579001'
      display: Anaphylactic reaction
  description: Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered
  onset: '2012-06-12'
  severity: severe
code:
  coding:
  - system: http://snomed.info/sct
    code: '227493005'
    display: Cashew nuts

No Known Drug Allergy

resourceType: AllergyIntolerance
id: nkda
patient:
  reference: Patient/pt-1
recordedDate: '2015-08-06T15:37:31-06:00'
clinicalStatus:
  coding:
  - system: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
    code: active
    display: Active
code:
  coding:
  - system: http://snomed.info/sct
    code: '409137002'
    display: No Known Drug Allergy (situation)
  text: NKDA

Since there can be several allergies - we should use Group Table (or Group) for them. It will allow us to grow a form with new elements.

Every table row should have next columns:

  • category (text input)

  • allergy code (text item)

  • reaction (Choice input)

  • criticality (Choice input)

Reaction and allergy code should be taken from Terminology server, in demo purposes we just set answerOptions with predefined values.

Create a table with columns

  1. Press + Add widget button in the outline

  2. Select Group Table in a opened widget panel.

You will get a group table with 2 items in it.

Now we must setup our inputs

  1. Remove predefined Group table's items

    • hover items with mouse and click on trash icon. (outline)

    • Hover Group Table item in the outline and click on + sign - this will open an items list panel for choosing item.

    • Select Choice Input item type in a items list panel

    • Type it's title = Category in text input of item's settings panel

    • Find Options section in Attributes segment of item's settings panel

      • code = food , display = Food

      • code = medication , display = Medication

      • code = environment , display = Environment

      • code = biologic , display = Biologic

  2. Create Allergy Code column

    • Repeat actions from 2nd step with next values

    • text = Allergy code

    • Options are

      • system = http://snomed.info/sct, code = 409137002, display = No Known Drug Allergy (situation)

      • system = http://snomed.info/sct, code = 227493005, display = Cashew nuts (in production we should use ValuseSet here, but for demo purposes we just fill our value from existed AllergyIntolerance resource)

  3. Create Reaction column and set answer options

    • Repeat actions from 2nd step with next values

    • text = Reaction

    • Options are:

      • code = 1160593, display = cashew nut allergenic extract Injectable Product (in production we should use ValuseSet here, but for demo purposes we just fill our value from existed AllergyIntolerance resource)

  4. Create Criticality column and set answer options

    • Repeat actions from 2nd step with next values

    • Find Options section in Attributes segment of item's settings panel

    • text = Criticality

      • code = low , display = Low Risk

      • code = high , display = High Risk

      • code = unable-to-assess , display = Unable to Assess Risk

Set table population expression

At first we should design and debug a FHIR Query to find AllergyIntolerance resources

For searching AllergyIntolerance we need only Patient reference that we get as %subject Input Parameter see Input Parameters section

Complete FHIR Search Query looks like this:

GET /AllergyIntolerance?patient=pt-1

We should specify form's named expression with this query, but with small modifications:

  • remove http method (GET)

  • replace patient parameter value (= pt-1) with embedded FHIRPath expression {{%subject.id}}

/AllergyIntolerance?patient={{%subject.id}}

Embedded FHIRPath expression {{%subject.id}} consists of:

  • {{}} - FHIRPath expression embedding point

  • %subject - populate input parameter. (all parameters start with % sign)

  • %subject.id - FHIRPath expression that extracts id from Patient reference

To specify named expression we should:

  1. Click on group table item in the outline panel

  2. Enable Populate section in item's settings panel (Observation population should be opened by default)

  3. Select Expression tab in Populate section.

  4. enter expression name = allergy (we will use expression by name in next section)

  5. set expression language = FHIRQuery

  6. Copy FHIRQuery that we get in last step

Set columns population expressions

For every column we should set populate expression which extracts data from %allergy named expression.

  1. Select column item in the outline

  2. Enable Populate section (Observation population should be opened by default)

  3. Select Expression tab

  4. Enter FHIRPath expression that extracts needed value.

Category (Choice input)

%qitem.answerOption.valueCoding.where(code = %allergy.category.first())

There can be several catigories but for demo purpores we just use first of them

Allergy code (Choice item)

%allergy.reaction.substance.coding.first()

Reaction (Choice input)

%allergy.reaction.substance.coding.first()

There can be several reactoins but for demo purpores we just use first of them

Criticality (Choice input)

%qitem.answerOption.valueCoding.where(code = %allergy.criticality)

Populate parameters (usage time)

To pass Patient's reference we use subject parameter to $populatelink/$populate operation.

Operation call example:

POST /fhir/Questionnaire/<qid>/$populatelink

resourceType: Parameters
parameter:
- name: subject
  valueReference:
    reference: Patient/example

How to populate form with data from another form during the visit

To populate a form with data from another form we should:

  1. setup a form to be able to find another form's response and get information from it (design time)

    • Enable input parameter, that is common for both forms. (Encounter in our case)

    • Set form's named expression with FHIRQuery to search for response in DB

    • Set item's populate expression to extract data from found QuestionnaireResponse

  2. provide Encounter reference in input parameters of populate operation (usage time)

Form Setup (design time)

Assume that we have:

  • 1st Form and it's response with captured data in DB, which will be used as data source

  • 2nd Form, that should be pre-populated

We are working only with 2nd form in this demo

Enable input parameter

To use %encounter input parameter - we should enable it.

  1. Click on form's name in the outline panel (top left corner of the Form Builder)

  2. In Populate section of form's settings panel click on Encounter checkbox.

Setup query to find a resource

Response of 1st form should be stored in DB and looks like this:

resourceType: QuestionnaireResponse
status: completed
questionnaire: http://aidbox.io/forms/patient-name|1.0.0
encounter:
  reference: Encounter/enc-1
item:
- linkId: patient-name
  text: Patient Name
  answer:
  - valueString: John Smith

We are interested in following values from it.

  • encounter reference - will be common with our form

  • questionnaire - unique Questionnaire's identifier

  • item's linkId - will be used to extract an answer in following section.

We need to build FHIR Search Query to find this response.

It's better to design and debug query in Aidbox REST Console

Complete FHIR Search Query looks like this:

GET /QuestionnaireResponse?status=completed&questionnaire=http://aidbox.io/forms/patient-name|1.0.0&encounter=enc-1

It uses several filter criteria:

  • status = completed - we need only submitted forms

  • questionnaire - canonical URL of response's questionnaire

  • encounter - our common reference, for example enc-1

We should specify form's named expression with this query, but with small modifications:

  • remove http method (GET)

  • replace encounter parameter value (= enc-1) with embedded FHIRPath expression {{%encounter.id}}

/QuestionnaireResponse?status=completed&questionnaire=http://aidbox.io/forms/patient-name|1.0.0&encounter={{%encounter.id}}

Embedded FHIRPath expression {{%encounter.id}} consists of:

  • {{}} - FHIRPath expression embedding point

  • %encounter - populate input parameter. (all parameters start with % sign)

  • %encounter.id - FHIRPath expression that extracts id from Encounter reference

To specify named expression we should:

  1. Click on form's name in the outline panel (top left corner of the Form Builder)

  2. In form's settings panel click button + Add Expression (Named Expressions section).

  3. Select created empty line

  4. enter expression name = response (we will use expression by name in next section)

  5. set expression language = FHIRQuery

  6. Copy FHIRQuery that we get in last step

  7. Click close button in the named expression form

Set item's populate expression

We should use created named expression (%response) to extract a value and fill out our item.

  1. Select the item in outline

  2. Enable Populate section (Observation population should be opened by default)

  3. Select Expression tab

  4. Enter FHIRPath expression that extracts needed value.

%response.repeat(item).where(linkId='patient-name').answer.value

Populate parameters (usage time)

To pass Encounter's reference we use context parameter - encounter to $populatelink/$populate operation

Operation call example:

POST /fhir/Questionnaire/<qid>/$populatelink

resourceType: Parameters
parameter:
- name: context
  part: 
    - name: name
      valueString: Encounter
    - name: value
      valueReference:
        reference: Encounter/enc-1
PreviousHow-to guidesNextHow to extract data from forms

Last updated 22 days ago

Was this helpful?

WARN: You should have items with types - that corresponds populate values types. (see )

WARN: You should have items with types - that corresponds populate values types. (see )

WARN: You should have items with types - that corresponds populate values types. (see )

Create Category column and set answer options

Fill out options with next value

Options are:

WARN: You should have items with types - that corresponds populate values types. (see )

Category item FHIR Spec
Category item FHIR Spec
Criticality item FHIR Spec
WARN section
WARN section
WARN section
WARN section