ca.uhn.fhir.model.dstu2.resource

Class Slot

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:

ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class Slot
extends BaseResource
implements ca.uhn.fhir.model.api.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 ca.uhn.fhir.rest.gclient.TokenClientParam	FB_TYPE Fluent Client search parameter constant for fb-type
static ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
static ca.uhn.fhir.model.api.Include	INCLUDE_SCHEDULE Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	SCHEDULE Fluent Client search parameter constant for schedule
static ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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()

Method Summary

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 ca.uhn.fhir.model.api.IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
String	getComment() Gets the value(s) for comment ().
ca.uhn.fhir.model.primitive.StringDt	getCommentElement() Gets the value(s) for comment ().
Date	getEnd() Gets the value(s) for end (when.planned).
ca.uhn.fhir.model.primitive.InstantDt	getEndElement() Gets the value(s) for end (when.planned).
String	getFreeBusyType() Gets the value(s) for freeBusyType ().
ca.uhn.fhir.model.primitive.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 ().
ca.uhn.fhir.model.primitive.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).
ca.uhn.fhir.model.primitive.InstantDt	getStartElement() Gets the value(s) for start (when.planned).
ca.uhn.fhir.context.FhirVersionEnum	getStructureFhirVersionEnum()
CodeableConceptDt	getType() Gets the value(s) for type (class).
boolean	isEmpty()
Slot	setComment(String theString) Sets the value for comment ()
Slot	setComment(ca.uhn.fhir.model.primitive.StringDt theValue) Sets the value(s) for comment ()
Slot	setEnd(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision) Sets the value for end (when.planned)
Slot	setEnd(ca.uhn.fhir.model.primitive.InstantDt theValue) Sets the value(s) for end (when.planned)
Slot	setEndWithMillisPrecision(Date theDate) Sets the value for end (when.planned)
Slot	setFreeBusyType(ca.uhn.fhir.model.primitive.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(ca.uhn.fhir.model.primitive.BooleanDt theValue) Sets the value(s) for overbooked ()
Slot	setSchedule(ResourceReferenceDt theValue) Sets the value(s) for schedule ()
Slot	setStart(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision) Sets the value for start (when.planned)
Slot	setStart(ca.uhn.fhir.model.primitive.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, getMeta, 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, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment

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, getMeta, 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 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.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 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

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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

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

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

Constructor Detail

Slot

public Slot()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

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

getAllPopulatedChildElementsOfType

public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Specified by:

getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.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 ca.uhn.fhir.model.primitive.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. This method may return null.

Definition:

setFreeBusyType

public Slot setFreeBusyType(ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.primitive.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. This method may return null.

Definition:

setStart

public Slot setStart(ca.uhn.fhir.model.primitive.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,
                     ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)

Sets the value for start (when.planned)

Definition:

getEndElement

public ca.uhn.fhir.model.primitive.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. This method may return null.

Definition:

setEnd

public Slot setEnd(ca.uhn.fhir.model.primitive.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,
                   ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)

Sets the value for end (when.planned)

Definition:

getOverbookedElement

public ca.uhn.fhir.model.primitive.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. This method may return null.

Definition:

setOverbooked

public Slot setOverbooked(ca.uhn.fhir.model.primitive.BooleanDt theValue)

Sets the value(s) for overbooked ()

Definition:

setOverbooked

public Slot setOverbooked(boolean theBoolean)

Sets the value for overbooked ()

Definition:

getCommentElement

public ca.uhn.fhir.model.primitive.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. This method may return null.

Definition:

setComment

public Slot setComment(ca.uhn.fhir.model.primitive.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 ca.uhn.fhir.model.api.IResource

getStructureFhirVersionEnum

public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()

Specified by:

getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource

Specified by:

getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource