Athena Core Implementation Guide
5.10.2 - release

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

Extension: athenahealth Location Department Details

Official URL: https://fhir.athena.io/StructureDefinition/ah-location-department-details Version: 5.10.2
Active as of 2026-05-26 Computable Name: AthenaLocationDepartmentDetails

An Extension containing details about a department location.

Context of Use

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

  • Element ID Location

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

Complex Extension: An Extension containing details about a department location.

  • isHospitalDepartment: boolean: Denotes if this department is a hospital department.
  • isServiceDepartment: boolean: Indicates if this is a department where billable services are performed (i.e. a department where you can create claims).
  • isHiddenInPortal: boolean: Indicates if department is hidden in portal.
  • isSchedulingDepartment: boolean: Indicates whether the department should appear in the scheduling UI.
  • patientFacingName: string: Name of the provider that is visible to patients.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Location Department Details
... extension 3..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:isHospitalDepartment 1..1 Extension Denotes if this department is a hospital department.
..... extension 0..0 Extension
..... url 1..1 uri "isHospitalDepartment"
..... value[x] 1..1 boolean Denotes if this department is a hospital department.
.... extension:isServiceDepartment 1..1 Extension Indicates if this is a department where billable services are performed
..... extension 0..0 Extension
..... url 1..1 uri "isServiceDepartment"
..... value[x] 1..1 boolean Indicates if this is a department where billable services are performed
.... extension:isHiddenInPortal 0..1 Extension Indicates if department is hidden in portal.
..... extension 0..0 Extension
..... url 1..1 uri "isHiddenInPortal"
..... value[x] 1..1 boolean Indicates if department is hidden in portal.
.... extension:isSchedulingDepartment 1..1 Extension Indicates whether the department should appear in the scheduling UI.
..... extension 0..0 Extension
..... url 1..1 uri "isSchedulingDepartment"
..... value[x] 1..1 boolean Indicates whether the department should appear in the scheduling UI.
.... extension:patientFacingName 0..1 Extension Name of the provider that is visible to patients.
..... extension 0..0 Extension
..... url 1..1 uri "patientFacingName"
..... value[x] 1..1 string Name of the provider that is visible to patients.
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-location-department-details"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Location Department Details
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:isHospitalDepartment 1..1 Extension Denotes if this department is a hospital department.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "isHospitalDepartment"
..... value[x] 1..1 boolean Denotes if this department is a hospital department.
.... extension:isServiceDepartment 1..1 Extension Indicates if this is a department where billable services are performed
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "isServiceDepartment"
..... value[x] 1..1 boolean Indicates if this is a department where billable services are performed
.... extension:isHiddenInPortal 0..1 Extension Indicates if department is hidden in 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 "isHiddenInPortal"
..... value[x] 1..1 boolean Indicates if department is hidden in portal.
.... extension:isSchedulingDepartment 1..1 Extension Indicates whether the department should appear in the scheduling UI.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "isSchedulingDepartment"
..... value[x] 1..1 boolean Indicates whether the department should appear in the scheduling UI.
.... extension:patientFacingName 0..1 Extension Name of the provider that is visible 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 "patientFacingName"
..... value[x] 1..1 string Name of the provider that is visible to patients.
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-location-department-details"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: An Extension containing details about a department location.

  • isHospitalDepartment: boolean: Denotes if this department is a hospital department.
  • isServiceDepartment: boolean: Indicates if this is a department where billable services are performed (i.e. a department where you can create claims).
  • isHiddenInPortal: boolean: Indicates if department is hidden in portal.
  • isSchedulingDepartment: boolean: Indicates whether the department should appear in the scheduling UI.
  • patientFacingName: string: Name of the provider that is visible to patients.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Location Department Details
... extension 3..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:isHospitalDepartment 1..1 Extension Denotes if this department is a hospital department.
..... extension 0..0 Extension
..... url 1..1 uri "isHospitalDepartment"
..... value[x] 1..1 boolean Denotes if this department is a hospital department.
.... extension:isServiceDepartment 1..1 Extension Indicates if this is a department where billable services are performed
..... extension 0..0 Extension
..... url 1..1 uri "isServiceDepartment"
..... value[x] 1..1 boolean Indicates if this is a department where billable services are performed
.... extension:isHiddenInPortal 0..1 Extension Indicates if department is hidden in portal.
..... extension 0..0 Extension
..... url 1..1 uri "isHiddenInPortal"
..... value[x] 1..1 boolean Indicates if department is hidden in portal.
.... extension:isSchedulingDepartment 1..1 Extension Indicates whether the department should appear in the scheduling UI.
..... extension 0..0 Extension
..... url 1..1 uri "isSchedulingDepartment"
..... value[x] 1..1 boolean Indicates whether the department should appear in the scheduling UI.
.... extension:patientFacingName 0..1 Extension Name of the provider that is visible to patients.
..... extension 0..0 Extension
..... url 1..1 uri "patientFacingName"
..... value[x] 1..1 string Name of the provider that is visible to patients.
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-location-department-details"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Location Department Details
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:isHospitalDepartment 1..1 Extension Denotes if this department is a hospital department.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "isHospitalDepartment"
..... value[x] 1..1 boolean Denotes if this department is a hospital department.
.... extension:isServiceDepartment 1..1 Extension Indicates if this is a department where billable services are performed
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "isServiceDepartment"
..... value[x] 1..1 boolean Indicates if this is a department where billable services are performed
.... extension:isHiddenInPortal 0..1 Extension Indicates if department is hidden in 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 "isHiddenInPortal"
..... value[x] 1..1 boolean Indicates if department is hidden in portal.
.... extension:isSchedulingDepartment 1..1 Extension Indicates whether the department should appear in the scheduling UI.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "isSchedulingDepartment"
..... value[x] 1..1 boolean Indicates whether the department should appear in the scheduling UI.
.... extension:patientFacingName 0..1 Extension Name of the provider that is visible 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 "patientFacingName"
..... value[x] 1..1 string Name of the provider that is visible to patients.
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-location-department-details"

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()