Provider
Class AvailableTime

This class represents a time period during the typical week during which the Provider is available. For example, if Dr. Smith works at Radiology Associates' Elm street location on Mondays, Wednesdays, and Fridays from 9 to 5, during which she normally takes lunch from 12-1, there will be six instances of this class, one for Monday with a start time of 9:00 AM and an end time of 12:00 PM, one for Monday from start time of 1:00 PM and an end time of 5:00 PM, and similarly for Wednesday and Friday. Alternatively, the provider may be scheduled in shifts (e.g., morning shift, evening shift). Because either the start and end times or the shifts may be used, all three properties are optional. The appointment window size property indicates the number of minutes that make up a schedulable block of time, for example, Dr. Smith may be scheduled in 15 minute increments.
Note that this class is used to schedule Providers and Healthcare Services independent of a Provider (e.g., scheduling an MRI without knowing or caring in advances the human practitioner who will perform the MRI).
"A collection of times that the Service Site is available." - HL7 FHIR, PractitionerRole.availableTime
"A collection of times that the Service Site is available." - HL7 FHIR, HealthcareService.availableTime

Attributes
Integer appointmentWindowSize appointmentWindowSize

Indicates the number of minutes that make up a schedulable block of time. For example, Dr. Smith may be scheduled in 15 minute increments, in which case this property would contain 15.

«CS» Code daysOfWeek daysOfWeek

The day of the week for which this schedule component is applicable. For example, if the schedule represents Monday with a start time of 9:00 AM and an end time of 12:00 PM, this property contains a code for Monday.
"Indicates which days of the week are available between the start and end Times." - HL7 FHIR, PractitionerRole.availableTime.daysOfWeek
"Indicates which days of the week are available between the start and end Times." - HL7 FHIR, HealthcareService.availableTime.daysOfWeek

«IVL_TS» Period effectiveDateRange effectiveDateRange

The time period during which this Schedule detail or component is valid. For active records, the end-date of this time period would be blank.

«TS» PointInTime endTime endTime

The end time for which this schedule component is applicable. For example, if the schedule represents Monday with a start time of 9:00 AM and an end time of 12:00 PM, this property contains 12:00 PM.
"The closing time of day. Note: If the AllDay flag is set, then this time is ignored." - HL7 FHIR, PractitionerRole.availableTime.availableEndTime
"The closing time of day. Note: If the AllDay flag is set, then this time is ignored." - HL7 FHIR, HealthcareService.availableTime.availableEndTime

Boolean isAllDay isAllDay

"Is this always available? (hence times are irrelevant) e.g. 24 hour service." - HL7 FHIR, PractitionerRole.availableTime.allDay
"Is this always available? (hence times are irrelevant) e.g. 24 hour service." - HL7 FHIR, HealthcareService.availableTime.allDay

String shift shift

This optional property may be used to describe a pre-defined time period that may be scheduled in situations where providers work in shifts. For example, morning shift, evening shift.

«TS» PointInTime startTime startTime

The start time for which this schedule component is applicable. For example, if the schedule represents Monday with a start time of 9:00 AM and an end time of 12:00 PM, this property contains 9:00 AM.
"The opening time of day. Note: If the AllDay flag is set, then this time is ignored." - HL7 FHIR, PractitionerRole.availableTime.availableStartTime
"The opening time of day. Note: If the AllDay flag is set, then this time is ignored." - HL7 FHIR, HealthcareService.availableTime.availableStartTime


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameAvailableTime
Name Expression
NamespaceProvider
Owned Template Signature
OwnerProvider
Owning Template Parameter
PackageProvider
Qualified NameFHIM::Provider::AvailableTime
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 appointmentWindowSize
Public Integer appointmentWindowSize

Indicates the number of minutes that make up a schedulable block of time. For example, Dr. Smith may be scheduled in 15 minute increments, in which case this property would contain 15.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAvailableTime
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameappointmentWindowSize
Name Expression
NamespaceAvailableTime
Opposite
OwnerAvailableTime
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::AvailableTime::appointmentWindowSize
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 daysOfWeek
Public «CS» Code daysOfWeek

The day of the week for which this schedule component is applicable. For example, if the schedule represents Monday with a start time of 9:00 AM and an end time of 12:00 PM, this property contains a code for Monday.
"Indicates which days of the week are available between the start and end Times." - HL7 FHIR, PractitionerRole.availableTime.daysOfWeek
"Indicates which days of the week are available between the start and end Times." - HL7 FHIR, HealthcareService.availableTime.daysOfWeek

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAvailableTime
Terminologies[
HL7_FHIR_R4 DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamedaysOfWeek
Name Expression
NamespaceAvailableTime
Opposite
OwnerAvailableTime
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::AvailableTime::daysOfWeek
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 effectiveDateRange
Public «IVL_TS» Period effectiveDateRange

The time period during which this Schedule detail or component is valid. For active records, the end-date of this time period would be blank.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAvailableTime
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NameeffectiveDateRange
Name Expression
NamespaceAvailableTime
Opposite
OwnerAvailableTime
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::AvailableTime::effectiveDateRange
Stereotype
Template Parameter
Type«IVL_TS» Period
Upper1
Upper Value(1)
VisibilityPublic


 endTime
Public «TS» PointInTime endTime

The end time for which this schedule component is applicable. For example, if the schedule represents Monday with a start time of 9:00 AM and an end time of 12:00 PM, this property contains 12:00 PM.
"The closing time of day. Note: If the AllDay flag is set, then this time is ignored." - HL7 FHIR, PractitionerRole.availableTime.availableEndTime
"The closing time of day. Note: If the AllDay flag is set, then this time is ignored." - HL7 FHIR, HealthcareService.availableTime.availableEndTime

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAvailableTime
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameendTime
Name Expression
NamespaceAvailableTime
Opposite
OwnerAvailableTime
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::AvailableTime::endTime
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 isAllDay
Public Boolean isAllDay

"Is this always available? (hence times are irrelevant) e.g. 24 hour service." - HL7 FHIR, PractitionerRole.availableTime.allDay
"Is this always available? (hence times are irrelevant) e.g. 24 hour service." - HL7 FHIR, HealthcareService.availableTime.allDay

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAvailableTime
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameisAllDay
Name Expression
NamespaceAvailableTime
Opposite
OwnerAvailableTime
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::AvailableTime::isAllDay
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 shift
Public String shift

This optional property may be used to describe a pre-defined time period that may be scheduled in situations where providers work in shifts. For example, morning shift, evening shift.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAvailableTime
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameshift
Name Expression
NamespaceAvailableTime
Opposite
OwnerAvailableTime
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::AvailableTime::shift
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 startTime
Public «TS» PointInTime startTime

The start time for which this schedule component is applicable. For example, if the schedule represents Monday with a start time of 9:00 AM and an end time of 12:00 PM, this property contains 9:00 AM.
"The opening time of day. Note: If the AllDay flag is set, then this time is ignored." - HL7 FHIR, PractitionerRole.availableTime.availableStartTime
"The opening time of day. Note: If the AllDay flag is set, then this time is ignored." - HL7 FHIR, HealthcareService.availableTime.availableStartTime

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAvailableTime
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamestartTime
Name Expression
NamespaceAvailableTime
Opposite
OwnerAvailableTime
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::AvailableTime::startTime
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic