Payerbox Docs

Aidbox as Questionnaire storage

Payerbox can deliver a self-contained Questionnaire bundle to a DTR client that does its own rendering. The client calls $questionnaire-package and receives a Bundle with the Questionnaire, all referenced ValueSets (expanded), and a draft QuestionnaireResponse prefilled from the launch context.

This is the API-side of DTR — Payerbox does not ship a UI for it. Choose it when the rendering app is owned by the EHR or by a third party (e.g., an in-EHR DTR client, an integrator's app), or when the client needs to render without launching a SMART app from Payerbox.

Example

POST /fhir/Questionnaire/$questionnaire-package
Content-Type: application/fhir+json
Accept: application/fhir+json

{
  "resourceType": "Parameters",
  "parameter": [
    { "name": "questionnaire", "valueCanonical": "http://example.org/Questionnaire/prior-auth-form|1.0" }
  ]
}
{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "packagebundle",
      "resource": {
        "resourceType": "Bundle",
        "type": "collection",
        "entry": [
          { "resource": { "resourceType": "Questionnaire", "id": "prior-auth-form", "url": "http://example.org/Questionnaire/prior-auth-form" } },
          { "resource": { "resourceType": "ValueSet", "url": "http://example.org/ValueSet/diagnosis-codes" } },
          { "resource": { "resourceType": "QuestionnaireResponse", "status": "in-progress", "subject": { "reference": "Patient/patient-456" } } }
        ]
      }
    }
  ]
}

When to choose this path vs DTR SMART App

This pathDTR SMART App
Who renders the questionnaireThe client (EHR, third-party DTR app)Payerbox-shipped SMART app
Launch mechanismDirect API callEHR SMART on FHIR launch
Prefill executionClient-side, by the DTR clientClient-side, inside the SMART app

The operation is implemented as a subset of Da Vinci DTR STU 2.0.1: it bundles the Questionnaire and its expanded ValueSets, and prefill uses the questionnaire's FHIRPath initialExpressions (no CQL). Full parameter list, limitations, and examples: $questionnaire-package.

The QuestionnaireResponse produced by either path becomes the input to PAS.

Last updated: