Package org.hl7.fhir.dstu3.model

Class Slot

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.model.Slot

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Slot
extends DomainResource

A slot of time on a schedule that may be available for booking appointments.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Slot.SlotStatus
static class	Slot.SlotStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	appointmentType	The style of appointment or patient that may be booked in the slot (not service type).
protected StringType	comment	Comments on the slot to describe any extended information.
protected InstantType	end	Date/Time that the slot is to conclude.
protected List<Identifier>	identifier	External Ids for this item.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_SCHEDULE	Constant for fluent queries to be used to add include statements.
protected BooleanType	overbooked	This slot has already been overbooked, appointments are unlikely to be accepted for this time.
protected Reference	schedule	The schedule resource that this slot defines an interval of status information.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SCHEDULE	Fluent Client search parameter constant for schedule
protected Schedule	scheduleTarget	The actual object that is the target of the reference (The schedule resource that this slot defines an interval of status information.)
protected CodeableConcept	serviceCategory	A broad categorisation of the service that is to be performed during this appointment.
protected List<CodeableConcept>	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).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SLOT_TYPE	Fluent Client search parameter constant for slot-type
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_SCHEDULE	Search parameter: schedule
static final String	SP_SLOT_TYPE	Search parameter: slot-type
static final String	SP_START	Search parameter: start
static final String	SP_STATUS	Search parameter: status
protected List<CodeableConcept>	specialty	The specialty of a practitioner that would be required to perform the service requested in this appointment.
protected InstantType	start	Date/Time that the slot is to begin.
static final ca.uhn.fhir.rest.gclient.DateClientParam	START	Fluent Client search parameter constant for start
protected Enumeration<Slot.SlotStatus>	status	busy | free | busy-unavailable | busy-tentative | entered-in-error.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Slot()	Constructor
Slot(Reference schedule, Enumeration<Slot.SlotStatus> status, InstantType start, InstantType end)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Identifier	addIdentifier()
Slot	addIdentifier(Identifier t)
CodeableConcept	addServiceType()
Slot	addServiceType(CodeableConcept t)
CodeableConcept	addSpecialty()
Slot	addSpecialty(CodeableConcept t)
Slot	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableConcept	getAppointmentType()
String	getComment()
StringType	getCommentElement()
Date	getEnd()
InstantType	getEndElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
boolean	getOverbooked()
BooleanType	getOverbookedElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
Reference	getSchedule()
Schedule	getScheduleTarget()
CodeableConcept	getServiceCategory()
List<CodeableConcept>	getServiceType()
CodeableConcept	getServiceTypeFirstRep()
List<CodeableConcept>	getSpecialty()
CodeableConcept	getSpecialtyFirstRep()
Date	getStart()
InstantType	getStartElement()
Slot.SlotStatus	getStatus()
Enumeration<Slot.SlotStatus>	getStatusElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAppointmentType()
boolean	hasComment()
boolean	hasCommentElement()
boolean	hasEnd()
boolean	hasEndElement()
boolean	hasIdentifier()
boolean	hasOverbooked()
boolean	hasOverbookedElement()
boolean	hasSchedule()
boolean	hasServiceCategory()
boolean	hasServiceType()
boolean	hasSpecialty()
boolean	hasStart()
boolean	hasStartElement()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
Slot	setAppointmentType(CodeableConcept value)
Slot	setComment(String value)
Slot	setCommentElement(StringType value)
Slot	setEnd(Date value)
Slot	setEndElement(InstantType value)
Slot	setIdentifier(List<Identifier> theIdentifier)
Slot	setOverbooked(boolean value)
Slot	setOverbookedElement(BooleanType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Slot	setSchedule(Reference value)
Slot	setScheduleTarget(Schedule value)
Slot	setServiceCategory(CodeableConcept value)
Slot	setServiceType(List<CodeableConcept> theServiceType)
Slot	setSpecialty(List<CodeableConcept> theSpecialty)
Slot	setStart(Date value)
Slot	setStartElement(InstantType value)
Slot	setStatus(Slot.SlotStatus value)
Slot	setStatusElement(Enumeration<Slot.SlotStatus> value)
protected Slot	typedCopy()

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.dstu3.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

External Ids for this item.

serviceCategory

protected CodeableConcept serviceCategory

A broad categorisation of the service that is to be performed during this appointment.

serviceType

protected List<CodeableConcept> 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.

specialty

protected List<CodeableConcept> specialty

The specialty of a practitioner that would be required to perform the service requested in this appointment.

appointmentType

protected CodeableConcept appointmentType

The style of appointment or patient that may be booked in the slot (not service type).

schedule

protected Reference schedule

The schedule resource that this slot defines an interval of status information.

scheduleTarget

protected Schedule scheduleTarget

The actual object that is the target of the reference (The schedule resource that this slot defines an interval of status information.)

status

protected Enumeration<Slot.SlotStatus> status

busy | free | busy-unavailable | busy-tentative | entered-in-error.

start

protected InstantType start

Date/Time that the slot is to begin.

end

protected InstantType end

Date/Time that the slot is to conclude.

overbooked

protected BooleanType overbooked

This slot has already been overbooked, appointments are unlikely to be accepted for this time.

comment

protected StringType comment

Comments on the slot to describe any extended information. Such as custom constraints on the slot.

SP_SCHEDULE

public static final String SP_SCHEDULE

Search parameter: schedule

Description: The Schedule Resource that we are seeking a slot within
Type: reference
Path: Slot.schedule

See Also:

• Constant Field Values

SCHEDULE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SCHEDULE

Fluent Client search parameter constant for schedule

Description: The Schedule Resource that we are seeking a slot within
Type: reference
Path: Slot.schedule

INCLUDE_SCHEDULE

public static final ca.uhn.fhir.model.api.Include INCLUDE_SCHEDULE

Constant for fluent queries to be used to add include statements. Specifies the path value of "Slot:schedule".

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: A Slot Identifier
Type: token
Path: Slot.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: A Slot Identifier
Type: token
Path: Slot.identifier

SP_START

public static final String SP_START

Search parameter: start

Description: Appointment date/time.
Type: date
Path: Slot.start

See Also:

• Constant Field Values

START

public static final ca.uhn.fhir.rest.gclient.DateClientParam START

Fluent Client search parameter constant for start

Description: Appointment date/time.
Type: date
Path: Slot.start

SP_SLOT_TYPE

public static final String SP_SLOT_TYPE

Search parameter: slot-type

Description: The type of appointments that can be booked into the slot
Type: token
Path: Slot.serviceType

See Also:

• Constant Field Values

SLOT_TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam SLOT_TYPE

Fluent Client search parameter constant for slot-type

Description: The type of appointments that can be booked into the slot
Type: token
Path: Slot.serviceType

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The free/busy status of the appointment
Type: token
Path: Slot.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: The free/busy status of the appointment
Type: token
Path: Slot.status

Constructor Details

Slot

public Slot()

Constructor

Slot

public Slot(Reference schedule,
 Enumeration<Slot.SlotStatus> status,
 InstantType start,
 InstantType end)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (External Ids for this item.)

setIdentifier

public Slot setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public Slot addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getServiceCategory

public CodeableConcept getServiceCategory()

Returns:

serviceCategory (A broad categorisation of the service that is to be performed during this appointment.)

hasServiceCategory

public boolean hasServiceCategory()

setServiceCategory

public Slot setServiceCategory(CodeableConcept value)

Parameters:

value - serviceCategory (A broad categorisation of the service that is to be performed during this appointment.)

getServiceType

public List<CodeableConcept> getServiceType()

Returns:

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

setServiceType

public Slot setServiceType(List<CodeableConcept> theServiceType)

Returns:

Returns a reference to this for easy method chaining

hasServiceType

public boolean hasServiceType()

addServiceType

public CodeableConcept addServiceType()

addServiceType

public Slot addServiceType(CodeableConcept t)

getServiceTypeFirstRep

public CodeableConcept getServiceTypeFirstRep()

Returns:

The first repetition of repeating field serviceType, creating it if it does not already exist

getSpecialty

public List<CodeableConcept> getSpecialty()

Returns:

specialty (The specialty of a practitioner that would be required to perform the service requested in this appointment.)

setSpecialty

public Slot setSpecialty(List<CodeableConcept> theSpecialty)

Returns:

Returns a reference to this for easy method chaining

hasSpecialty

public boolean hasSpecialty()

addSpecialty

public CodeableConcept addSpecialty()

addSpecialty

public Slot addSpecialty(CodeableConcept t)

getSpecialtyFirstRep

public CodeableConcept getSpecialtyFirstRep()

Returns:

The first repetition of repeating field specialty, creating it if it does not already exist

getAppointmentType

public CodeableConcept getAppointmentType()

Returns:

appointmentType (The style of appointment or patient that may be booked in the slot (not service type).)

hasAppointmentType

public boolean hasAppointmentType()

setAppointmentType

public Slot setAppointmentType(CodeableConcept value)

Parameters:

value - appointmentType (The style of appointment or patient that may be booked in the slot (not service type).)

getSchedule

public Reference getSchedule()

Returns:

schedule (The schedule resource that this slot defines an interval of status information.)

hasSchedule

public boolean hasSchedule()

setSchedule

public Slot setSchedule(Reference value)

Parameters:

value - schedule (The schedule resource that this slot defines an interval of status information.)

getScheduleTarget

public Schedule getScheduleTarget()

Returns:

schedule The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The schedule resource that this slot defines an interval of status information.)

setScheduleTarget

public Slot setScheduleTarget(Schedule value)

Parameters:

value - schedule The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The schedule resource that this slot defines an interval of status information.)

getStatusElement

public Enumeration<Slot.SlotStatus> getStatusElement()

Returns:

status (busy | free | busy-unavailable | busy-tentative | entered-in-error.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public Slot setStatusElement(Enumeration<Slot.SlotStatus> value)

Parameters:

value - status (busy | free | busy-unavailable | busy-tentative | entered-in-error.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Slot.SlotStatus getStatus()

Returns:

busy | free | busy-unavailable | busy-tentative | entered-in-error.

setStatus

public Slot setStatus(Slot.SlotStatus value)

Parameters:

value - busy | free | busy-unavailable | busy-tentative | entered-in-error.

getStartElement

public InstantType getStartElement()

Returns:

start (Date/Time that the slot is to begin.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value

hasStartElement

public boolean hasStartElement()

hasStart

public boolean hasStart()

setStartElement

public Slot setStartElement(InstantType value)

Parameters:

value - start (Date/Time that the slot is to begin.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value

getStart

public Date getStart()

Returns:

Date/Time that the slot is to begin.

setStart

public Slot setStart(Date value)

Parameters:

value - Date/Time that the slot is to begin.

getEndElement

public InstantType getEndElement()

Returns:

end (Date/Time that the slot is to conclude.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value

hasEndElement

public boolean hasEndElement()

hasEnd

public boolean hasEnd()

setEndElement

public Slot setEndElement(InstantType value)

Parameters:

value - end (Date/Time that the slot is to conclude.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value

getEnd

public Date getEnd()

Returns:

Date/Time that the slot is to conclude.

setEnd

public Slot setEnd(Date value)

Parameters:

value - Date/Time that the slot is to conclude.

getOverbookedElement

public BooleanType getOverbookedElement()

Returns:

overbooked (This slot has already been overbooked, appointments are unlikely to be accepted for this time.). This is the underlying object with id, value and extensions. The accessor "getOverbooked" gives direct access to the value

hasOverbookedElement

public boolean hasOverbookedElement()

hasOverbooked

public boolean hasOverbooked()

setOverbookedElement

public Slot setOverbookedElement(BooleanType value)

Parameters:

value - overbooked (This slot has already been overbooked, appointments are unlikely to be accepted for this time.). This is the underlying object with id, value and extensions. The accessor "getOverbooked" gives direct access to the value

getOverbooked

public boolean getOverbooked()

Returns:

This slot has already been overbooked, appointments are unlikely to be accepted for this time.

setOverbooked

public Slot setOverbooked(boolean value)

Parameters:

value - This slot has already been overbooked, appointments are unlikely to be accepted for this time.

getCommentElement

public StringType getCommentElement()

Returns:

comment (Comments on the slot to describe any extended information. Such as custom constraints on the slot.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value

hasCommentElement

public boolean hasCommentElement()

hasComment

public boolean hasComment()

setCommentElement

public Slot setCommentElement(StringType value)

Parameters:

value - comment (Comments on the slot to describe any extended information. Such as custom constraints on the slot.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value

getComment

public String getComment()

Returns:

Comments on the slot to describe any extended information. Such as custom constraints on the slot.

setComment

public Slot setComment(String value)

Parameters:

value - Comments on the slot to describe any extended information. Such as custom constraints on the slot.

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public Slot copy()

Specified by:

copy in class DomainResource

typedCopy

protected Slot typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource