Athena Core Implementation Guide
5.11.2 - release
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
| Official URL: https://fhir.athena.io/StructureDefinition/ah-appointment-service-type-details | Version: 5.11.2 | |||
| Active as of 2026-07-07 | Computable Name: AthenaAppointmentServiceTypeDetails | |||
An Extension containing details about an appointment service type.
Context of Use
This extension may be used on the following element(s):
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
Summary
Complex Extension: An Extension containing details about an appointment service type.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | athenahealth Appointment Service Type Details | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:shortName |
0..1 | Extension | Short name for the appointment service type. | |
   extension |
0..0 | Extension | ||
| url |
1..1 | uri | "shortName" | |
  value[x] |
0..1 | string | Short name for the appointment service type. | |
| extension:duration |
0..1 | Extension | Duration for the appointment service type. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "duration" | |
| value[x] |
0..1 | integer | Duration for the appointment service type. | |
| extension:patientDisplayName |
0..1 | Extension | Patient-facing display name for the appointment service type. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "patientDisplayName" | |
| value[x] |
0..1 | string | Patient-facing display name for the appointment service type. | |
| extension:isPatient |
0..1 | Extension | Whether the appointment service type applies to patients. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "isPatient" | |
| value[x] |
0..1 | boolean | Whether the appointment service type applies to patients. | |
| extension:isTemplateTypeOnly |
0..1 | Extension | Whether the appointment service type is template type only. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "isTemplateTypeOnly" | |
| value[x] |
0..1 | boolean | Whether the appointment service type is template type only. | |
| extension:isGeneric |
0..1 | Extension | Whether the appointment service type is generic. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "isGeneric" | |
| value[x] |
0..1 | boolean | Whether the appointment service type is generic. | |
 extension:hideInPortal |
0..1 | Extension | Whether the appointment service type is hidden in the portal. | |
 extension |
0..0 | Extension | ||
| url |
1..1 | uri | "hideInPortal" | |
| value[x] |
0..1 | boolean | Whether the appointment service type is hidden in the portal. | |
 url |
1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-appointment-service-type-details" | |
 value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | athenahealth Appointment Service Type Details | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:shortName |
0..1 | Extension | Short name for the appointment service type. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "shortName" | |
| value[x] |
0..1 | string | Short name for the appointment service type. | |
| extension:duration |
0..1 | Extension | Duration for the appointment service type. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "duration" | |
| value[x] |
0..1 | integer | Duration for the appointment service type. | |
| extension:patientDisplayName |
0..1 | Extension | Patient-facing display name for the appointment service type. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "patientDisplayName" | |
| value[x] |
0..1 | string | Patient-facing display name for the appointment service type. | |
| extension:isPatient |
0..1 | Extension | Whether the appointment service type applies to patients. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "isPatient" | |
| value[x] |
0..1 | boolean | Whether the appointment service type applies to patients. | |
| extension:isTemplateTypeOnly |
0..1 | Extension | Whether the appointment service type is template type only. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "isTemplateTypeOnly" | |
| value[x] |
0..1 | boolean | Whether the appointment service type is template type only. | |
| extension:isGeneric |
0..1 | Extension | Whether the appointment service type is generic. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "isGeneric" | |
| value[x] |
0..1 | boolean | Whether the appointment service type is generic. | |
| extension:hideInPortal |
0..1 | Extension | Whether the appointment service type is hidden in the portal. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "hideInPortal" | |
| value[x] |
0..1 | boolean | Whether the appointment service type is hidden in the portal. | |
| url |
1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-appointment-service-type-details" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Complex Extension: An Extension containing details about an appointment service type.
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | athenahealth Appointment Service Type Details | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:shortName |
0..1 | Extension | Short name for the appointment service type. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "shortName" | |
| value[x] |
0..1 | string | Short name for the appointment service type. | |
| extension:duration |
0..1 | Extension | Duration for the appointment service type. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "duration" | |
| value[x] |
0..1 | integer | Duration for the appointment service type. | |
| extension:patientDisplayName |
0..1 | Extension | Patient-facing display name for the appointment service type. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "patientDisplayName" | |
| value[x] |
0..1 | string | Patient-facing display name for the appointment service type. | |
| extension:isPatient |
0..1 | Extension | Whether the appointment service type applies to patients. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "isPatient" | |
| value[x] |
0..1 | boolean | Whether the appointment service type applies to patients. | |
| extension:isTemplateTypeOnly |
0..1 | Extension | Whether the appointment service type is template type only. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "isTemplateTypeOnly" | |
| value[x] |
0..1 | boolean | Whether the appointment service type is template type only. | |
| extension:isGeneric |
0..1 | Extension | Whether the appointment service type is generic. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "isGeneric" | |
| value[x] |
0..1 | boolean | Whether the appointment service type is generic. | |
| extension:hideInPortal |
0..1 | Extension | Whether the appointment service type is hidden in the portal. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "hideInPortal" | |
| value[x] |
0..1 | boolean | Whether the appointment service type is hidden in the portal. | |
| url |
1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-appointment-service-type-details" | |
| value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | athenahealth Appointment Service Type Details | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:shortName |
0..1 | Extension | Short name for the appointment service type. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "shortName" | |
| value[x] |
0..1 | string | Short name for the appointment service type. | |
| extension:duration |
0..1 | Extension | Duration for the appointment service type. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "duration" | |
| value[x] |
0..1 | integer | Duration for the appointment service type. | |
| extension:patientDisplayName |
0..1 | Extension | Patient-facing display name for the appointment service type. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "patientDisplayName" | |
| value[x] |
0..1 | string | Patient-facing display name for the appointment service type. | |
| extension:isPatient |
0..1 | Extension | Whether the appointment service type applies to patients. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "isPatient" | |
| value[x] |
0..1 | boolean | Whether the appointment service type applies to patients. | |
| extension:isTemplateTypeOnly |
0..1 | Extension | Whether the appointment service type is template type only. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "isTemplateTypeOnly" | |
| value[x] |
0..1 | boolean | Whether the appointment service type is template type only. | |
| extension:isGeneric |
0..1 | Extension | Whether the appointment service type is generic. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "isGeneric" | |
| value[x] |
0..1 | boolean | Whether the appointment service type is generic. | |
| extension:hideInPortal |
0..1 | Extension | Whether the appointment service type is hidden in the portal. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "hideInPortal" | |
| value[x] |
0..1 | boolean | Whether the appointment service type is hidden in the portal. | |
| url |
1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-appointment-service-type-details" | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| 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()
|