Provider UML Documentation

Element

Provider
Class Slot

"A slot of time on a schedule that may be available for booking appointments." - HL7 FHIR, Slot

Attributes
«CS» Code	appointmentType	"The style of appointment or patient that may be booked in the slot (not service type)." - HL7 FHIR, Slot.appointmentType
String	comment	"Comments on the slot to describe any extended information. Such as custom Terminologies on the slot." - HL7 FHIR, Slot.comment
«TS» PointInTime	dateTimeEnd	"Date/Time that the slot is to conclude." - HL7 FHIR, Slot.end
«TS» PointInTime	dateTimeStart	"Date/Time that the slot is to begin." - HL7 FHIR, Slot.start
«II» Id	identifier	"External Ids for this item." - HL7 FHIR, Slot.identifier
Boolean	isOverbooked	"This slot has already been overbooked, appointments are unlikely to be accepted for this time." - HL7 FHIR, Slot.overbooked
Schedule	schedule	"The schedule resource that this slot defines an interval of status information." - HL7 FHIR, Slot.schedule
«CS» Code	serviceCategory	"A broad categorisation of the service that is to be performed during this appointment." - HL7 FHIR, Slot.serviceCategory
«CS» Code	serviceType	"The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource." - HL7 FHIR, Slot.serviceType
«CS» Code	specialty	"The specialty of a practitioner that would be required to perform the service requested in this appointment." - HL7 FHIR, Slot.specialty
«CS» Code	status	"busy \| free \| busy-unavailable \| busy-tentative \| entered-in-error." - HL7 FHIR, Slot.status

Properties:

Alias
Classifier Behavior
Is Abstract	false
Is Active	false
Is Leaf	false
Keywords
Name	Slot
Name Expression
Namespace	Provider
Owned Template Signature
Owner	Provider
Owning Template Parameter
Package	Provider
Qualified Name	FHIM::Provider::Slot
Representation
Stereotype
Template Parameter
Visibility	Public

Attribute Details

appointmentType

Public «CS» Code appointmentType

"The style of appointment or patient that may be booked in the slot (not service type)." - HL7 FHIR, Slot.appointmentType

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Slot
Terminologies	[ HL7_FHIR_R4 HL7 v2 Appointment Reason Codes http://terminology.hl7.org/CodeSystem/v2-0276 ]
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	appointmentType
Name Expression
Namespace	Slot
Opposite
Owner	Slot
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Slot::appointmentType
Stereotype	ValueSetConstraints
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

comment

Public String comment

"Comments on the slot to describe any extended information. Such as custom Terminologies on the slot." - HL7 FHIR, Slot.comment

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Slot
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	comment
Name Expression
Namespace	Slot
Opposite
Owner	Slot
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Slot::comment
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value	(1)
Visibility	Public

dateTimeEnd

Public «TS» PointInTime dateTimeEnd

"Date/Time that the slot is to conclude." - HL7 FHIR, Slot.end

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Slot
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value	(1)
Multiplicity	1
Name	dateTimeEnd
Name Expression
Namespace	Slot
Opposite
Owner	Slot
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Slot::dateTimeEnd
Stereotype
Template Parameter
Type	«TS» PointInTime
Upper	1
Upper Value	(1)
Visibility	Public

dateTimeStart

Public «TS» PointInTime dateTimeStart

"Date/Time that the slot is to begin." - HL7 FHIR, Slot.start

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Slot
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value	(1)
Multiplicity	1
Name	dateTimeStart
Name Expression
Namespace	Slot
Opposite
Owner	Slot
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Slot::dateTimeStart
Stereotype
Template Parameter
Type	«TS» PointInTime
Upper	1
Upper Value	(1)
Visibility	Public

identifier

Public «II» Id identifier

"External Ids for this item." - HL7 FHIR, Slot.identifier

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Slot
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	identifier
Name Expression
Namespace	Slot
Opposite
Owner	Slot
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Slot::identifier
Stereotype
Template Parameter
Type	«II» Id
Upper	*
Upper Value	(*)
Visibility	Public

isOverbooked

Public Boolean isOverbooked

"This slot has already been overbooked, appointments are unlikely to be accepted for this time." - HL7 FHIR, Slot.overbooked

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Slot
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	isOverbooked
Name Expression
Namespace	Slot
Opposite
Owner	Slot
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Slot::isOverbooked
Stereotype
Template Parameter
Type	Boolean
Upper	1
Upper Value	(1)
Visibility	Public

schedule

Public Schedule schedule

"The schedule resource that this slot defines an interval of status information." - HL7 FHIR, Slot.schedule

Constraints:

Properties:

Aggregation	None
Alias
Association	slot_schedule
Association End
Class	Slot
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value	(1)
Multiplicity	1
Name	schedule
Name Expression
Namespace	Slot
Opposite
Owner	Slot
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Slot::schedule
Stereotype
Template Parameter
Type	Schedule
Upper	1
Upper Value	(1)
Visibility	Public

serviceCategory

Public «CS» Code serviceCategory

"A broad categorisation of the service that is to be performed during this appointment." - HL7 FHIR, Slot.serviceCategory

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Slot
Terminologies	[ HL7_FHIR_R4 Service category http://hl7.org/fhir/ValueSet/service-category ]
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	serviceCategory
Name Expression
Namespace	Slot
Opposite
Owner	Slot
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Slot::serviceCategory
Stereotype	ValueSetConstraints
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

serviceType

Public «CS» Code serviceType

"The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource." - HL7 FHIR, Slot.serviceType

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Slot
Terminologies	[ HL7_FHIR_R4 Service type http://hl7.org/fhir/ValueSet/service-type ]
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	serviceType
Name Expression
Namespace	Slot
Opposite
Owner	Slot
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Slot::serviceType
Stereotype	ValueSetConstraints
Template Parameter
Type	«CS» Code
Upper	*
Upper Value	(*)
Visibility	Public

specialty

Public «CS» Code specialty

"The specialty of a practitioner that would be required to perform the service requested in this appointment." - HL7 FHIR, Slot.specialty

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Slot
Terminologies	[ HL7_FHIR_R4 Practice Setting Code Value Set http://hl7.org/fhir/ValueSet/c80-practice-codes ]
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	specialty
Name Expression
Namespace	Slot
Opposite
Owner	Slot
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Slot::specialty
Stereotype	ValueSetConstraints
Template Parameter
Type	«CS» Code
Upper	*
Upper Value	(*)
Visibility	Public

status

Public «CS» Code status

"busy | free | busy-unavailable | busy-tentative | entered-in-error." - HL7 FHIR, Slot.status

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Slot
Terminologies	[ HL7_FHIR_R4 SlotStatus http://hl7.org/fhir/ValueSet/slotstatus ]
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value	(1)
Multiplicity	1
Name	status
Name Expression
Namespace	Slot
Opposite
Owner	Slot
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Slot::status
Stereotype	ValueSetConstraints
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

Overview

Top

Package

Element

Provider UML Documentation

Summary:AttributesProperties

Detail:Attributes