Package org.hl7.fhir.dstu2.model
Class 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 classSlot.SlotStatusstatic classSlot.SlotStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected StringTypecommentComments on the slot to describe any extended information.protected InstantTypeendDate/Time that the slot is to conclude.protected Enumeration<Slot.SlotStatus>freeBusyTypebusy | free | busy-unavailable | busy-tentative.protected List<Identifier>identifierExternal Ids for this item.protected BooleanTypeoverbookedThis slot has already been overbooked, appointments are unlikely to be accepted for this time.protected ReferencescheduleThe schedule resource that this slot defines an interval of status information.protected SchedulescheduleTargetThe actual object that is the target of the reference (The schedule resource that this slot defines an interval of status information.)static StringSP_FBTYPEstatic StringSP_IDENTIFIERstatic StringSP_SCHEDULEstatic StringSP_SLOTTYPEstatic StringSP_STARTprotected InstantTypestartDate/Time that the slot is to begin.protected CodeableConcepttypeThe 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).-
Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Slot()Slot(Reference schedule, Enumeration<Slot.SlotStatus> freeBusyType, InstantType start, InstantType end)
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
External Ids for this item.
-
type
protected CodeableConcept type
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.
-
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.)
-
freeBusyType
protected Enumeration<Slot.SlotStatus> freeBusyType
busy | free | busy-unavailable | busy-tentative.
-
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
- See Also:
- Constant Field Values
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
- See Also:
- Constant Field Values
-
SP_START
public static final String SP_START
- See Also:
- Constant Field Values
-
SP_SLOTTYPE
public static final String SP_SLOTTYPE
- See Also:
- Constant Field Values
-
SP_FBTYPE
public static final String SP_FBTYPE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Slot
public Slot()
-
Slot
public Slot(Reference schedule, Enumeration<Slot.SlotStatus> freeBusyType, InstantType start, InstantType end)
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(External Ids for this item.)
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
- Returns:
identifier(External Ids for this item.)
-
addIdentifier
public Slot addIdentifier(Identifier t)
-
getType
public CodeableConcept getType()
- Returns:
type(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.)
-
hasType
public boolean hasType()
-
setType
public Slot setType(CodeableConcept value)
- Parameters:
value-type(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.)
-
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:
scheduleThe 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-scheduleThe 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.)
-
getFreeBusyTypeElement
public Enumeration<Slot.SlotStatus> getFreeBusyTypeElement()
- Returns:
freeBusyType(busy | free | busy-unavailable | busy-tentative.). This is the underlying object with id, value and extensions. The accessor "getFreeBusyType" gives direct access to the value
-
hasFreeBusyTypeElement
public boolean hasFreeBusyTypeElement()
-
hasFreeBusyType
public boolean hasFreeBusyType()
-
setFreeBusyTypeElement
public Slot setFreeBusyTypeElement(Enumeration<Slot.SlotStatus> value)
- Parameters:
value-freeBusyType(busy | free | busy-unavailable | busy-tentative.). This is the underlying object with id, value and extensions. The accessor "getFreeBusyType" gives direct access to the value
-
getFreeBusyType
public Slot.SlotStatus getFreeBusyType()
- Returns:
- busy | free | busy-unavailable | busy-tentative.
-
setFreeBusyType
public Slot setFreeBusyType(Slot.SlotStatus value)
- Parameters:
value- busy | free | busy-unavailable | busy-tentative.
-
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
-
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
-
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> childrenList)
- Overrides:
listChildrenin classDomainResource
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Slot copy()
- Specified by:
copyin classDomainResource
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-