Skip to main content

ScanPreviewResult

Result of previewing scanned BMP codes. Nothing in this result has been persisted. Deliberately not shaped like the create/update *Payload types (no success/medicationPlan fields) — nothing has been created yet, there is no MedicationPlan to return.

type ScanPreviewResult {
duplicateScans: [DuplicateScan!]!
foreignPlanScans: [ForeignPlanScan!]!
invalidScans: [InvalidScan!]!
issuedAt: Time
issuedByName: String
issuedOn: Date
medications: [ScannedMedication!]!
missingPages: [Int!]!
page: Int
totalPages: Int
}

Fields

ScanPreviewResult.duplicateScans ● [DuplicateScan!]! non-null object

ScanPreviewResult.foreignPlanScans ● [ForeignPlanScan!]! non-null object

Scanned codes belonging to a different plan instance than the primary one.

ScanPreviewResult.invalidScans ● [InvalidScan!]! non-null object

Scanned codes that could not be parsed or failed structural validation. Reported uniformly — the field-level distinction isn't exposed, matching the AC.

ScanPreviewResult.issuedAt ● Time scalar

ScanPreviewResult.issuedByName ● String scalar

Name of the issuing doctor/practice as scanned — not yet matched to a DoctorContact.

ScanPreviewResult.issuedOn ● Date scalar

ScanPreviewResult.medications ● [ScannedMedication!]! non-null object

ScanPreviewResult.missingPages ● [Int!]! non-null scalar

ScanPreviewResult.page ● Int scalar

Page number of the primary scanned document (BMP attribute a). Null for single-page plans.

ScanPreviewResult.totalPages ● Int scalar

Total number of pages declared in the plan (BMP attribute z). Null for single-page plans.

Returned By

previewScan mutation