Provider UML Documentation

Element

Provider
Class Schedule

"A container for slots of time that may be available for booking appointments." - HL7 FHIR, Schedule

Attributes
Participation	actor	"The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson." - HL7 FHIR, Schedule.actor
String	comment	"Comments on the availability to describe any extended information. Such as custom Terminologies on the slots that may be associated." - HL7 FHIR, Schedule.comment
«II» Id	identifier	"External Ids for this item." - HL7 FHIR, Schedule.identifier
Boolean	isActive	"Whether this schedule record is in active use, or should not be used (such as was entered in error)." - HL7 FHIR, Schedule.active
«IVL_TS» Period	planningHorizon	"The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates." - HL7 FHIR, Schedule.planningHorizon
«CS» Code	serviceCategory	"A broad categorisation of the service that is to be performed during this appointment." - HL7 FHIR, Schedule.serviceCategory
«CS» Code	serviceType	"The specific service that is to be performed during this appointment." - HL7 FHIR, Schedule.serviceType
«CS» Code	specialty	"The specialty of a practitioner that would be required to perform the service requested in this appointment." - HL7 FHIR, Schedule.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	Schedule
Name Expression
Namespace	Provider
Owned Template Signature
Owner	Provider
Owning Template Parameter
Package	Provider
Qualified Name	FHIM::Provider::Schedule
Representation
Stereotype
Template Parameter
Visibility	Public

Attribute Details

actor

Public Participation actor

"The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson." - HL7 FHIR, Schedule.actor

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Schedule
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	actor
Name Expression
Namespace	Schedule
Opposite
Owner	Schedule
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Schedule::actor
Stereotype
Template Parameter
Type	Participation
Upper	*
Upper Value	(*)
Visibility	Public

comment

Public String comment

"Comments on the availability to describe any extended information. Such as custom Terminologies on the slots that may be associated." - HL7 FHIR, Schedule.comment

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Schedule
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	Schedule
Opposite
Owner	Schedule
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Schedule::comment
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value	(1)
Visibility	Public

identifier

Public «II» Id identifier

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

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Schedule
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	Schedule
Opposite
Owner	Schedule
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Schedule::identifier
Stereotype
Template Parameter
Type	«II» Id
Upper	*
Upper Value	(*)
Visibility	Public

isActive

Public Boolean isActive

"Whether this schedule record is in active use, or should not be used (such as was entered in error)." - HL7 FHIR, Schedule.active

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Schedule
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	isActive
Name Expression
Namespace	Schedule
Opposite
Owner	Schedule
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Schedule::isActive
Stereotype
Template Parameter
Type	Boolean
Upper	1
Upper Value	(1)
Visibility	Public

planningHorizon

Public «IVL_TS» Period planningHorizon

"The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates." - HL7 FHIR, Schedule.planningHorizon

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Schedule
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	planningHorizon
Name Expression
Namespace	Schedule
Opposite
Owner	Schedule
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Schedule::planningHorizon
Stereotype
Template Parameter
Type	«IVL_TS» Period
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, Schedule.serviceCategory

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Schedule
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	Schedule
Opposite
Owner	Schedule
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Schedule::serviceCategory
Stereotype	ValueSetConstraints
Template Parameter
Type	«CS» Code
Upper	1
Upper Value	(1)
Visibility	Public

serviceType

Public «CS» Code serviceType

"The specific service that is to be performed during this appointment." - HL7 FHIR, Schedule.serviceType

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Schedule
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	Schedule
Opposite
Owner	Schedule
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Schedule::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, Schedule.specialty

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Schedule
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	Schedule
Opposite
Owner	Schedule
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Schedule::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	Schedule
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	Schedule
Opposite
Owner	Schedule
Owning Association
Owning Template Parameter
Qualified Name	FHIM::Provider::Schedule::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