ca.uhn.fhir.model.dstu.resource

Class Slot

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseResource

ca.uhn.fhir.model.dstu.resource.Slot

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions

public class Slot
extends BaseResource
implements IResource

HAPI/FHIR Slot Resource ((informative) A slot of time that may be available for booking appointments)

Definition:

Requirements:

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

Field Summary

Fields

Modifier and Type	Field and Description
static ReferenceClientParam	AVAILABILITY Fluent Client search parameter constant for availability
static TokenClientParam	FBTYPE Fluent Client search parameter constant for fbtype
static Include	INCLUDE_AVAILABILITY Constant for fluent queries to be used to add include statements.
static TokenClientParam	SLOTTYPE Fluent Client search parameter constant for slottype
static String	SP_AVAILABILITY Search parameter constant for availability
static String	SP_FBTYPE Search parameter constant for fbtype
static String	SP_SLOTTYPE Search parameter constant for slottype
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.api.BaseResource

SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
Slot()

Method Summary

Methods

Modifier and Type	Method and Description
IdentifierDt	addIdentifier() Adds and returns a new value for identifier (External Ids for this item)
Slot	addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Adds a new value for identifier (External Ids for this item)
Slot	addIdentifier(String theSystem, String theValue) Adds a new value for identifier (External Ids for this item)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
ResourceReferenceDt	getAuthor() Gets the value(s) for author (Who authored the slot).
DateTimeDt	getAuthorDate() Gets the value(s) for authorDate (When this slot was created, or last revised).
ResourceReferenceDt	getAvailability() Gets the value(s) for availability (The availability resource that this slot defines an interval of status information).
StringDt	getComment() Gets the value(s) for comment (Comments on the slot to describe any extended information.
InstantDt	getEnd() Gets the value(s) for end (Date/Time that the slot is to conclude).
CodeDt	getFreeBusyType() Gets the value(s) for freeBusyType (BUSY | FREE | BUSY-UNAVAILABLE | BUSY-TENTATIVE).
List<IdentifierDt>	getIdentifier() Gets the value(s) for identifier (External Ids for this item).
IdentifierDt	getIdentifierFirstRep() Gets the first repetition for identifier (External Ids for this item), creating it if it does not already exist.
InstantDt	getStart() Gets the value(s) for start (Date/Time that the slot is to begin).
CodeableConceptDt	getType() Gets the value(s) for 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).
boolean	isEmpty()
Slot	setAuthor(ResourceReferenceDt theValue) Sets the value(s) for author (Who authored the slot)
Slot	setAuthorDate(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for authorDate (When this slot was created, or last revised)
Slot	setAuthorDate(DateTimeDt theValue) Sets the value(s) for authorDate (When this slot was created, or last revised)
Slot	setAuthorDateWithSecondsPrecision(Date theDate) Sets the value for authorDate (When this slot was created, or last revised)
Slot	setAvailability(ResourceReferenceDt theValue) Sets the value(s) for availability (The availability resource that this slot defines an interval of status information)
Slot	setComment(String theString) Sets the value for comment (Comments on the slot to describe any extended information.
Slot	setComment(StringDt theValue) Sets the value(s) for comment (Comments on the slot to describe any extended information.
Slot	setEnd(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for end (Date/Time that the slot is to conclude)
Slot	setEnd(InstantDt theValue) Sets the value(s) for end (Date/Time that the slot is to conclude)
Slot	setEndWithMillisPrecision(Date theDate) Sets the value for end (Date/Time that the slot is to conclude)
Slot	setFreeBusyType(CodeDt theValue) Sets the value(s) for freeBusyType (BUSY | FREE | BUSY-UNAVAILABLE | BUSY-TENTATIVE)
Slot	setFreeBusyType(String theCode) Sets the value for freeBusyType (BUSY | FREE | BUSY-UNAVAILABLE | BUSY-TENTATIVE)
Slot	setIdentifier(List<IdentifierDt> theValue) Sets the value(s) for identifier (External Ids for this item)
Slot	setStart(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for start (Date/Time that the slot is to begin)
Slot	setStart(InstantDt theValue) Sets the value(s) for start (Date/Time that the slot is to begin)
Slot	setStartWithMillisPrecision(Date theDate) Sets the value for start (Date/Time that the slot is to begin)
Slot	setType(CodeableConceptDt theValue) Sets the value(s) for 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).

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

getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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

Field Detail

SP_SLOTTYPE

public static final String SP_SLOTTYPE

Search parameter constant for slottype

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

See Also:

Constant Field Values

SLOTTYPE

public static final TokenClientParam SLOTTYPE

Fluent Client search parameter constant for slottype

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

SP_AVAILABILITY

public static final String SP_AVAILABILITY

Search parameter constant for availability

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

See Also:

Constant Field Values

AVAILABILITY

public static final ReferenceClientParam AVAILABILITY

Fluent Client search parameter constant for availability

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

INCLUDE_AVAILABILITY

public static final Include INCLUDE_AVAILABILITY

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

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_FBTYPE

public static final String SP_FBTYPE

Search parameter constant for fbtype

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

See Also:

Constant Field Values

FBTYPE

public static final TokenClientParam FBTYPE

Fluent Client search parameter constant for fbtype

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

Constructor Detail

Slot

public Slot()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getIdentifier

public List<IdentifierDt> getIdentifier()

Gets the value(s) for identifier (External Ids for this item). 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 (External Ids for this item)

Definition:

addIdentifier

public IdentifierDt addIdentifier()

Adds and returns a new value for identifier (External Ids for this item)

Definition:

getIdentifierFirstRep

public IdentifierDt getIdentifierFirstRep()

Gets the first repetition for identifier (External Ids for this item), creating it if it does not already exist.

Definition:

addIdentifier

public Slot addIdentifier(IdentifierUseEnum theUse,
                 String theSystem,
                 String theValue,
                 String theLabel)

Adds a new value for identifier (External Ids for this item)

Definition:

Returns:

Returns a reference to this object, to allow for simple chaining.

addIdentifier

public Slot addIdentifier(String theSystem,
                 String theValue)

Adds a new value for identifier (External Ids for this item)

Definition:

Returns:

Returns a reference to this object, to allow for simple chaining.

getType

public CodeableConceptDt getType()

Gets the value(s) for 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). creating it if it does not exist. Will not return null.

Definition:

setType

public Slot setType(CodeableConceptDt theValue)

Sets the value(s) for 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)

Definition:

getAvailability

public ResourceReferenceDt getAvailability()

Gets the value(s) for availability (The availability resource that this slot defines an interval of status information). creating it if it does not exist. Will not return null.

Definition:

setAvailability

public Slot setAvailability(ResourceReferenceDt theValue)

Sets the value(s) for availability (The availability resource that this slot defines an interval of status information)

Definition:

getFreeBusyType

public CodeDt getFreeBusyType()

Gets the value(s) for freeBusyType (BUSY | FREE | BUSY-UNAVAILABLE | BUSY-TENTATIVE). creating it if it does not exist. Will not return null.

Definition:

setFreeBusyType

public Slot setFreeBusyType(CodeDt theValue)

Sets the value(s) for freeBusyType (BUSY | FREE | BUSY-UNAVAILABLE | BUSY-TENTATIVE)

Definition:

setFreeBusyType

public Slot setFreeBusyType(String theCode)

Sets the value for freeBusyType (BUSY | FREE | BUSY-UNAVAILABLE | BUSY-TENTATIVE)

Definition:

getStart

public InstantDt getStart()

Gets the value(s) for start (Date/Time that the slot is to begin). creating it if it does not exist. Will not return null.

Definition:

setStart

public Slot setStart(InstantDt theValue)

Sets the value(s) for start (Date/Time that the slot is to begin)

Definition:

setStart

public Slot setStart(Date theDate,
            TemporalPrecisionEnum thePrecision)

Sets the value for start (Date/Time that the slot is to begin)

Definition:

setStartWithMillisPrecision

public Slot setStartWithMillisPrecision(Date theDate)

Sets the value for start (Date/Time that the slot is to begin)

Definition:

getEnd

public InstantDt getEnd()

Gets the value(s) for end (Date/Time that the slot is to conclude). creating it if it does not exist. Will not return null.

Definition:

setEnd

public Slot setEnd(InstantDt theValue)

Sets the value(s) for end (Date/Time that the slot is to conclude)

Definition:

setEnd

public Slot setEnd(Date theDate,
          TemporalPrecisionEnum thePrecision)

Sets the value for end (Date/Time that the slot is to conclude)

Definition:

setEndWithMillisPrecision

public Slot setEndWithMillisPrecision(Date theDate)

Sets the value for end (Date/Time that the slot is to conclude)

Definition:

getComment

public StringDt getComment()

Gets the value(s) for comment (Comments on the slot to describe any extended information. Such as custom constraints on the slot). creating it if it does not exist. Will not return null.

Definition:

setComment

public Slot setComment(StringDt theValue)

Sets the value(s) for comment (Comments on the slot to describe any extended information. Such as custom constraints on the slot)

Definition:

setComment

public Slot setComment(String theString)

Sets the value for comment (Comments on the slot to describe any extended information. Such as custom constraints on the slot)

Definition:

getAuthor

public ResourceReferenceDt getAuthor()

Gets the value(s) for author (Who authored the slot). creating it if it does not exist. Will not return null.

Definition:

setAuthor

public Slot setAuthor(ResourceReferenceDt theValue)

Sets the value(s) for author (Who authored the slot)

Definition:

getAuthorDate

public DateTimeDt getAuthorDate()

Gets the value(s) for authorDate (When this slot was created, or last revised). creating it if it does not exist. Will not return null.

Definition:

setAuthorDate

public Slot setAuthorDate(DateTimeDt theValue)

Sets the value(s) for authorDate (When this slot was created, or last revised)

Definition:

setAuthorDateWithSecondsPrecision

public Slot setAuthorDateWithSecondsPrecision(Date theDate)

Sets the value for authorDate (When this slot was created, or last revised)

Definition:

setAuthorDate

public Slot setAuthorDate(Date theDate,
                 TemporalPrecisionEnum thePrecision)

Sets the value for authorDate (When this slot was created, or last revised)

Definition: