Slot (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.Slot

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class Slot
extends BaseResource
implements IResource
```
HAPI/FHIR Slot Resource (workflow.scheduling)
Definition: A slot of time on a schedule that may be available for booking appointments.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/Slot

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`FB_TYPE` Fluent Client search parameter constant for fb-type
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_SCHEDULE` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`SCHEDULE` Fluent Client search parameter constant for schedule
`static TokenClientParam`	`SLOT_TYPE` Fluent Client search parameter constant for slot-type
`static String`	`SP_FB_TYPE` Search parameter constant for fb-type
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_SCHEDULE` Search parameter constant for schedule
`static String`	`SP_SLOT_TYPE` Search parameter constant for slot-type
`static String`	`SP_START` Search parameter constant for start
`static DateClientParam`	`START` Fluent Client search parameter constant for start

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

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

Constructor Summary

Constructors
Constructor and Description

Slot()

Constructors
Constructor and Description
`Slot()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (id)
`Slot`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier (id)
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`String`	`getComment()` Gets the value(s) for comment ().
`StringDt`	`getCommentElement()` Gets the value(s) for comment ().
`Date`	`getEnd()` Gets the value(s) for end (when.planned).
`InstantDt`	`getEndElement()` Gets the value(s) for end (when.planned).
`String`	`getFreeBusyType()` Gets the value(s) for freeBusyType ().
`BoundCodeDt<SlotStatusEnum>`	`getFreeBusyTypeElement()` Gets the value(s) for freeBusyType ().
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (id).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (id), creating it if it does not already exist.
`Boolean`	`getOverbooked()` Gets the value(s) for overbooked ().
`BooleanDt`	`getOverbookedElement()` Gets the value(s) for overbooked ().
`String`	`getResourceName()`
`ResourceReferenceDt`	`getSchedule()` Gets the value(s) for schedule ().
`Date`	`getStart()` Gets the value(s) for start (when.planned).
`InstantDt`	`getStartElement()` Gets the value(s) for start (when.planned).
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`CodeableConceptDt`	`getType()` Gets the value(s) for type (class).
`boolean`	`isEmpty()`
`Slot`	`setComment(String theString)` Sets the value for comment ()
`Slot`	`setComment(StringDt theValue)` Sets the value(s) for comment ()
`Slot`	`setEnd(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for end (when.planned)
`Slot`	`setEnd(InstantDt theValue)` Sets the value(s) for end (when.planned)
`Slot`	`setEndWithMillisPrecision(Date theDate)` Sets the value for end (when.planned)
`Slot`	`setFreeBusyType(BoundCodeDt<SlotStatusEnum> theValue)` Sets the value(s) for freeBusyType ()
`Slot`	`setFreeBusyType(SlotStatusEnum theValue)` Sets the value(s) for freeBusyType ()
`Slot`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (id)
`Slot`	`setOverbooked(boolean theBoolean)` Sets the value for overbooked ()
`Slot`	`setOverbooked(BooleanDt theValue)` Sets the value(s) for overbooked ()
`Slot`	`setSchedule(ResourceReferenceDt theValue)` Sets the value(s) for schedule ()
`Slot`	`setStart(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for start (when.planned)
`Slot`	`setStart(InstantDt theValue)` Sets the value(s) for start (when.planned)
`Slot`	`setStartWithMillisPrecision(Date theDate)` Sets the value for start (when.planned)
`Slot`	`setType(CodeableConceptDt theValue)` Sets the value(s) for type (class)

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

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

- Field Detail
  - SP_SLOT_TYPE
```
public static final String SP_SLOT_TYPE
```
    Search parameter constant for slot-type
    Description: The type of appointments that can be booked into the slot
    Type: token
    Path: Slot.type
    
    See Also:
    
    Constant Field Values
  - SLOT_TYPE
```
public static final 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.type
  - SP_SCHEDULE
```
public static final String SP_SCHEDULE
```
    Search parameter constant for 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 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
  - SP_START
```
public static final String SP_START
```
    Search parameter constant for start
    Description: Appointment date/time.
    Type: date
    Path: Slot.start
    
    See Also:
    
    Constant Field Values
  - START
```
public static final DateClientParam START
```
    Fluent Client search parameter constant for start
    Description: Appointment date/time.
    Type: date
    Path: Slot.start
  - SP_FB_TYPE
```
public static final String SP_FB_TYPE
```
    Search parameter constant for fb-type
    Description: The free/busy status of the appointment
    Type: token
    Path: Slot.freeBusyType
    
    See Also:
    
    Constant Field Values
  - FB_TYPE
```
public static final TokenClientParam FB_TYPE
```
    Fluent Client search parameter constant for fb-type
    Description: The free/busy status of the appointment
    Type: token
    Path: Slot.freeBusyType
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: A Slot Identifier
    Type: token
    Path: Slot.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: A Slot Identifier
    Type: token
    Path: Slot.identifier
  - INCLUDE_SCHEDULE
```
public static final Include INCLUDE_SCHEDULE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Slot:schedule".
- Constructor Detail
  - Slot
```
public Slot()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.
    Definition:
  - setIdentifier
```
public Slot setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (id)
    Definition:
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (id)
    Definition:
  - addIdentifier
```
public Slot addIdentifier(IdentifierDt theValue)
```
    Adds a given new value for identifier (id)
    Definition:
    
    Parameters:
    
    theValue - The identifier to add (must not be null)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (id), creating it if it does not already exist.
    Definition:
  - getType
```
public CodeableConceptDt getType()
```
    Gets the value(s) for type (class). creating it if it does not exist. Will not return null.
    Definition:
  - setType
```
public Slot setType(CodeableConceptDt theValue)
```
    Sets the value(s) for type (class)
    Definition:
  - getSchedule
```
public ResourceReferenceDt getSchedule()
```
    Gets the value(s) for schedule (). creating it if it does not exist. Will not return null.
    Definition:
  - setSchedule
```
public Slot setSchedule(ResourceReferenceDt theValue)
```
    Sets the value(s) for schedule ()
    Definition:
  - getFreeBusyTypeElement
```
public BoundCodeDt<SlotStatusEnum> getFreeBusyTypeElement()
```
    Gets the value(s) for freeBusyType (). creating it if it does not exist. Will not return null.
    Definition:
  - getFreeBusyType
```
public String getFreeBusyType()
```
    Gets the value(s) for freeBusyType (). creating it if it does not exist. Will not return null.
    Definition:
  - setFreeBusyType
```
public Slot setFreeBusyType(BoundCodeDt<SlotStatusEnum> theValue)
```
    Sets the value(s) for freeBusyType ()
    Definition:
  - setFreeBusyType
```
public Slot setFreeBusyType(SlotStatusEnum theValue)
```
    Sets the value(s) for freeBusyType ()
    Definition:
  - getStartElement
```
public InstantDt getStartElement()
```
    Gets the value(s) for start (when.planned). creating it if it does not exist. Will not return null.
    Definition:
  - getStart
```
public Date getStart()
```
    Gets the value(s) for start (when.planned). creating it if it does not exist. Will not return null.
    Definition:
  - setStart
```
public Slot setStart(InstantDt theValue)
```
    Sets the value(s) for start (when.planned)
    Definition:
  - setStartWithMillisPrecision
```
public Slot setStartWithMillisPrecision(Date theDate)
```
    Sets the value for start (when.planned)
    Definition:
  - setStart
```
public Slot setStart(Date theDate,
                     TemporalPrecisionEnum thePrecision)
```
    Sets the value for start (when.planned)
    Definition:
  - getEndElement
```
public InstantDt getEndElement()
```
    Gets the value(s) for end (when.planned). creating it if it does not exist. Will not return null.
    Definition:
  - getEnd
```
public Date getEnd()
```
    Gets the value(s) for end (when.planned). creating it if it does not exist. Will not return null.
    Definition:
  - setEnd
```
public Slot setEnd(InstantDt theValue)
```
    Sets the value(s) for end (when.planned)
    Definition:
  - setEndWithMillisPrecision
```
public Slot setEndWithMillisPrecision(Date theDate)
```
    Sets the value for end (when.planned)
    Definition:
  - setEnd
```
public Slot setEnd(Date theDate,
                   TemporalPrecisionEnum thePrecision)
```
    Sets the value for end (when.planned)
    Definition:
  - getOverbookedElement
```
public BooleanDt getOverbookedElement()
```
    Gets the value(s) for overbooked (). creating it if it does not exist. Will not return null.
    Definition:
  - getOverbooked
```
public Boolean getOverbooked()
```
    Gets the value(s) for overbooked (). creating it if it does not exist. Will not return null.
    Definition:
  - setOverbooked
```
public Slot setOverbooked(BooleanDt theValue)
```
    Sets the value(s) for overbooked ()
    Definition:
  - setOverbooked
```
public Slot setOverbooked(boolean theBoolean)
```
    Sets the value for overbooked ()
    Definition:
  - getCommentElement
```
public StringDt getCommentElement()
```
    Gets the value(s) for comment (). creating it if it does not exist. Will not return null.
    Definition:
  - getComment
```
public String getComment()
```
    Gets the value(s) for comment (). creating it if it does not exist. Will not return null.
    Definition:
  - setComment
```
public Slot setComment(StringDt theValue)
```
    Sets the value(s) for comment ()
    Definition:
  - setComment
```
public Slot setComment(String theString)
```
    Sets the value for comment ()
    Definition:
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class Slot

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

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

Field Detail

SP_SLOT_TYPE

SLOT_TYPE

SP_SCHEDULE

SCHEDULE

SP_START

START

SP_FB_TYPE

FB_TYPE

SP_IDENTIFIER

IDENTIFIER

INCLUDE_SCHEDULE

Constructor Detail

Slot

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getType

setType

getSchedule

setSchedule

getFreeBusyTypeElement

getFreeBusyType

setFreeBusyType

setFreeBusyType

getStartElement

getStart

setStart

setStartWithMillisPrecision

setStart

getEndElement

getEnd

setEnd

setEndWithMillisPrecision

setEnd

getOverbookedElement

getOverbooked

setOverbooked

setOverbooked

getCommentElement

getComment

setComment

setComment

getResourceName

getStructureFhirVersionEnum