Athena Core Implementation Guide
5.15.0 - release
Athena Core Implementation Guide - Local Development build (v5.15.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.athena.io/OperationDefinition/ah-questionnaireresponse-patient-reason-for-visit | Version: 5.15.0 | |||
| Draft as of 2026-10-23 | Computable Name: PatientReasonForVisit | |||
Information Source: athenacoreext
URL: [base]/QuestionnaireResponse/$patient-reason-for-visit
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | questionnaireResponse | 1..1 | QuestionnaireResponse | Must conform to https://fhir.athena.io/StructureDefinition/ah-patient-reason-for-visit. | ||
| OUT | warning | 0..1 | OperationOutcome | Non-fatal advisory information about the matching attempt (e.g. low-confidence input, ambiguous text). | ||
| OUT | match | 0..* | A candidate appointment service-type match for the supplied reason for visit. | |||
| OUT | match.rank | 1..1 | positiveInt | Ordinal position of this match among all matches returned for the same response, where 1 is the best match. Rank is stable within a single operation invocation but MUST NOT be compared across different invocations or different QuestionnaireResponse inputs. | ||
| OUT | match.score | 0..1 | decimal | Relative confidence score for this match, expressed as a decimal in the range [0, 1]. Scores are meaningful only when compared against other matches returned for the same QuestionnaireResponse input; they MUST NOT be compared across different inputs or invocations. | ||
| OUT | match.serviceType | 1..1 | Coding | athenahealth Appointment Service Type (Required) | The appointment service-type coding that this match proposes. The coding is drawn from the ah-appointment-service-type value set and corresponds to the service type that the matching algorithm considers most consistent with the patient-supplied reason for visit. |