Skip to content

Billing Launch Refusal Reason CodeSystem Code system

Canonicalhttps://fhir.apps.health/CodeSystem/nexus-billing-launch-refusal
Statusdraft · 1.33.0
Contentcomplete
SourceFSH · JSON

Why a billing launch was refused, published on OperationOutcome.issue.details.coding in place of a launch.

Only a refusal carries a reason. A launch that launched returns a launch, and an ending reached before the gate that would name a reason carries none.

These are wire words, not user-facing text. A caller matches the code and writes its own sentence; the advisory text beside it is developer-facing and is not a translation of the code.

⚠ Tolerate an unlisted code. This is every reason the platform publishes as of this version, but the service and this guide ship on different cadences, so the set can grow between releases. Match the reasons you have a sentence for and fall back to a generic one for the rest -- a launch refused for an unrecognised reason is still refused. Bind extensible.

Each definition says whether asking again could succeed; the code spelling does not.

CodeDisplayDefinition
featureDisabledFeature disabledBilling is not enabled for this clinic. Retrying will not change it; the clinic has to be configured for billing.
provinceNotSupportedProvince not supportedThe clinic's operating province is not one a launch can bill through. Permanent for that clinic.
actingUserIncompleteActing user incompleteThere is nobody to sign in as: the caller is a machine identity, or is a person the record holds no name or email for. Retrying with the same caller will not change it.
appointmentNotFoundAppointment not foundThe reference names no appointment the store holds. Permanent for that reference.
appointmentUnreadableAppointment unreadableThe appointment exists but could not be read. This is a platform fault rather than a statement about the request, and is worth asking again.
patientMissingPatient missingThe appointment names no patient this platform can read, so there is nobody to bill for.
billingPractitionerUnresolvedBilling practitioner unresolvedNobody in the appointment's billing practitioner chain carries a usable provincial billing number. Retrying will not change it until a billing number is recorded.
appointmentNumberInvalidAppointment number invalidDeclared for completeness and not currently emitted: the appointment number is optional and best-effort, so a launch does not refuse on it.
credentialMissingCredential missingThe clinic holds no usable billing-vendor credential, so the vendor cannot be asked. Retrying will not change it until a credential is configured.
launchInProgressLaunch in progressA launch is already being minted for this person, and a second would invalidate the first. Worth asking again once the first completes.
rateLimitedRate limitedThe vendor asked for a longer pacing wait than a person should be held for. Transient; worth asking again.
vendorRejectedVendor rejectedThe vendor refused the sign-in. Asking again with the same input will not change the answer.
vendorUnavailableVendor unavailableThe vendor could not be reached, or answered with no usable sign-in. Transient; worth asking again.