
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
A slot of time on a schedule that may be available for booking appointments.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumstatic class -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringTypeComments on the slot to describe any extended information.protected InstantTypeDate/Time that the slot is to conclude.protected Enumeration<Slot.SlotStatus> busy | free | busy-unavailable | busy-tentative.protected List<Identifier> External Ids for this item.protected BooleanTypeThis slot has already been overbooked, appointments are unlikely to be accepted for this time.protected ReferenceThe schedule resource that this slot defines an interval of status information.protected ScheduleThe actual object that is the target of the reference (The schedule resource that this slot defines an interval of status information.)static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringprotected InstantTypeDate/Time that the slot is to begin.protected CodeableConceptThe 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, textFields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, metaFields 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_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
ConstructorsConstructorDescriptionSlot()Slot(Reference schedule, Enumeration<Slot.SlotStatus> freeBusyType, InstantType start, InstantType end) -
Method Summary
Modifier and TypeMethodDescriptioncopy()booleanequalsDeep(Base other) booleanequalsShallow(Base other) fhirType()getEnd()booleangetStart()getType()booleanbooleanbooleanhasEnd()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasStart()booleanbooleanhasType()booleanisEmpty()protected voidlistChildren(List<Property> childrenList) setComment(String value) setCommentElement(StringType value) setEndElement(InstantType value) setFreeBusyType(Slot.SlotStatus value) setOverbooked(boolean value) setOverbookedElement(BooleanType value) voidsetProperty(String name, Base value) setSchedule(Reference value) setScheduleTarget(Schedule value) setStartElement(InstantType value) setType(CodeableConcept value) protected SlotMethods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setTextMethods 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, setMetaMethods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setIdMethods 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, setUserDataINNMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
External Ids for this item. -
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
The schedule resource that this slot defines an interval of status information. -
scheduleTarget
The actual object that is the target of the reference (The schedule resource that this slot defines an interval of status information.) -
freeBusyType
busy | free | busy-unavailable | busy-tentative. -
start
Date/Time that the slot is to begin. -
end
Date/Time that the slot is to conclude. -
overbooked
This slot has already been overbooked, appointments are unlikely to be accepted for this time. -
comment
Comments on the slot to describe any extended information. Such as custom constraints on the slot. -
SP_SCHEDULE
- See Also:
-
SP_IDENTIFIER
- See Also:
-
SP_START
- See Also:
-
SP_SLOTTYPE
- See Also:
-
SP_FBTYPE
- See Also:
-
-
Constructor Details
-
Slot
public Slot() -
Slot
public Slot(Reference schedule, Enumeration<Slot.SlotStatus> freeBusyType, InstantType start, InstantType end)
-
-
Method Details
-
getIdentifier
- Returns:
identifier(External Ids for this item.)
-
hasIdentifier
-
addIdentifier
- Returns:
identifier(External Ids for this item.)
-
addIdentifier
-
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
-
setType
- 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
- Returns:
schedule(The schedule resource that this slot defines an interval of status information.)
-
hasSchedule
-
setSchedule
- Parameters:
value-schedule(The schedule resource that this slot defines an interval of status information.)
-
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
- 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
- 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
-
hasFreeBusyType
-
setFreeBusyTypeElement
- 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
- Returns:
- busy | free | busy-unavailable | busy-tentative.
-
setFreeBusyType
- Parameters:
value- busy | free | busy-unavailable | busy-tentative.
-
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
-
hasStart
-
setStartElement
- 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
- Returns:
- Date/Time that the slot is to begin.
-
setStart
- Parameters:
value- Date/Time that the slot is to begin.
-
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
-
hasEnd
-
setEndElement
- 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
- Returns:
- Date/Time that the slot is to conclude.
-
setEnd
- Parameters:
value- Date/Time that the slot is to conclude.
-
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
-
hasOverbooked
-
setOverbookedElement
- 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
- Returns:
- This slot has already been overbooked, appointments are unlikely to be accepted for this time.
-
setOverbooked
- Parameters:
value- This slot has already been overbooked, appointments are unlikely to be accepted for this time.
-
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
-
hasComment
-
setCommentElement
- 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
- Returns:
- Comments on the slot to describe any extended information. Such as custom constraints on the slot.
-
setComment
- Parameters:
value- Comments on the slot to describe any extended information. Such as custom constraints on the slot.
-
listChildren
- Overrides:
listChildrenin classDomainResource
-
setProperty
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
- Specified by:
copyin classDomainResource
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
- Specified by:
getResourceTypein classResource
-