Athena Core Implementation Guide
5.11.2 - release

Athena Core Implementation Guide - Local Development build (v5.11.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: athenahealth Appointment Cancellation Reason Required

Official URL: https://fhir.athena.io/StructureDefinition/ah-appointment-cancellation-reason-required Version: 5.11.2
Active as of 2026-07-07 Computable Name: AthenaAppointmentCancellationReasonRequired

An extension indicating whether a cancellation reason is required when cancelling an appointment.

Indicates whether a cancellation reason is required when cancelling an appointment.

Context of Use

This extension may be used on the following element(s):

  • Element ID HealthcareService

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Simple Extension with the type boolean: An extension indicating whether a cancellation reason is required when cancelling an appointment.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Appointment Cancellation Reason Required
... extension 0..0 Extension
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-appointment-cancellation-reason-required"
... value[x] 1..1 boolean Whether a cancellation reason is required

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Appointment Cancellation Reason Required
... id 0..1 string Unique id for inter-element referencing
... extension 0..0 Extension
Slice: Unordered, Open by value:url
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-appointment-cancellation-reason-required"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type boolean: An extension indicating whether a cancellation reason is required when cancelling an appointment.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Appointment Cancellation Reason Required
... extension 0..0 Extension
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-appointment-cancellation-reason-required"
... value[x] 1..1 boolean Whether a cancellation reason is required

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Appointment Cancellation Reason Required
... id 0..1 string Unique id for inter-element referencing
... extension 0..0 Extension
Slice: Unordered, Open by value:url
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-appointment-cancellation-reason-required"

doco Documentation for this format

 

​Other representations of profile: CSV, Excel, Schematron

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()