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 static ca.uhn.fhir.rest.gclient.TokenClientParamAPPOINTMENT_TYPEFluent Client search parameter constant for appointment-typeprotected CodeableConceptappointmentTypeThe style of appointment or patient that may be booked in the slot (not service type).protected StringTypecommentComments on the slot to describe any extended information.protected InstantTypeendDate/Time that the slot is to conclude.protected List<Identifier>identifierExternal Ids for this item.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_SCHEDULEConstant for fluent queries to be used to add include statements.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.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSCHEDULEFluent Client search parameter constant for scheduleprotected SchedulescheduleTargetThe actual object that is the target of the reference (The schedule resource that this slot defines an interval of status information.)static ca.uhn.fhir.rest.gclient.TokenClientParamSERVICE_CATEGORYFluent Client search parameter constant for service-categorystatic ca.uhn.fhir.rest.gclient.TokenClientParamSERVICE_TYPEFluent Client search parameter constant for service-typeprotected List<CodeableConcept>serviceCategoryA broad categorization of the service that is to be performed during this appointment.protected List<CodeableConcept>serviceTypeThe 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).static StringSP_APPOINTMENT_TYPESearch parameter: appointment-typestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_SCHEDULESearch parameter: schedulestatic StringSP_SERVICE_CATEGORYSearch parameter: service-categorystatic StringSP_SERVICE_TYPESearch parameter: service-typestatic StringSP_SPECIALTYSearch parameter: specialtystatic StringSP_STARTSearch parameter: startstatic StringSP_STATUSSearch parameter: statusprotected List<CodeableConcept>specialtyThe specialty of a practitioner that would be required to perform the service requested in this appointment.static ca.uhn.fhir.rest.gclient.TokenClientParamSPECIALTYFluent Client search parameter constant for specialtyprotected InstantTypestartDate/Time that the slot is to begin.static ca.uhn.fhir.rest.gclient.DateClientParamSTARTFluent Client search parameter constant for startprotected Enumeration<Slot.SlotStatus>statusbusy | free | busy-unavailable | busy-tentative | entered-in-error.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for status-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Slot()ConstructorSlot(Reference schedule, Enumeration<Slot.SlotStatus> status, InstantType start, InstantType end)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, 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.
-
serviceCategory
protected List<CodeableConcept> serviceCategory
A broad categorization of the service that is to be performed during this appointment.
-
serviceType
protected List<CodeableConcept> serviceType
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.
-
specialty
protected List<CodeableConcept> specialty
The specialty of a practitioner that would be required to perform the service requested in this appointment.
-
appointmentType
protected CodeableConcept appointmentType
The style of appointment or patient that may be booked in the slot (not service type).
-
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.)
-
status
protected Enumeration<Slot.SlotStatus> status
busy | free | busy-unavailable | busy-tentative | entered-in-error.
-
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
Search parameter: scheduleDescription: 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 scheduleDescription: The Schedule Resource that we are seeking a slot within
Type: reference
Path: Slot.schedule
-
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".
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: 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 identifierDescription: A Slot Identifier
Type: token
Path: Slot.identifier
-
SP_SPECIALTY
public static final String SP_SPECIALTY
Search parameter: specialtyDescription: The specialty of a practitioner that would be required to perform the service requested in this appointment
Type: token
Path: Slot.specialty
- See Also:
- Constant Field Values
-
SPECIALTY
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SPECIALTY
Fluent Client search parameter constant for specialtyDescription: The specialty of a practitioner that would be required to perform the service requested in this appointment
Type: token
Path: Slot.specialty
-
SP_SERVICE_CATEGORY
public static final String SP_SERVICE_CATEGORY
Search parameter: service-categoryDescription: A broad categorization of the service that is to be performed during this appointment
Type: token
Path: Slot.serviceCategory
- See Also:
- Constant Field Values
-
SERVICE_CATEGORY
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERVICE_CATEGORY
Fluent Client search parameter constant for service-categoryDescription: A broad categorization of the service that is to be performed during this appointment
Type: token
Path: Slot.serviceCategory
-
SP_APPOINTMENT_TYPE
public static final String SP_APPOINTMENT_TYPE
Search parameter: appointment-typeDescription: The style of appointment or patient that may be booked in the slot (not service type)
Type: token
Path: Slot.appointmentType
- See Also:
- Constant Field Values
-
APPOINTMENT_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam APPOINTMENT_TYPE
Fluent Client search parameter constant for appointment-typeDescription: The style of appointment or patient that may be booked in the slot (not service type)
Type: token
Path: Slot.appointmentType
-
SP_SERVICE_TYPE
public static final String SP_SERVICE_TYPE
Search parameter: service-typeDescription: The type of appointments that can be booked into the slot
Type: token
Path: Slot.serviceType
- See Also:
- Constant Field Values
-
SERVICE_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERVICE_TYPE
Fluent Client search parameter constant for service-typeDescription: The type of appointments that can be booked into the slot
Type: token
Path: Slot.serviceType
-
SP_START
public static final String SP_START
Search parameter: startDescription: 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 startDescription: Appointment date/time.
Type: date
Path: Slot.start
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: The free/busy status of the appointment
Type: token
Path: Slot.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: The free/busy status of the appointment
Type: token
Path: Slot.status
-
-
Constructor Detail
-
Slot
public Slot()
Constructor
-
Slot
public Slot(Reference schedule, Enumeration<Slot.SlotStatus> status, InstantType start, InstantType end)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(External Ids for this item.)
-
setIdentifier
public Slot setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public Slot addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getServiceCategory
public List<CodeableConcept> getServiceCategory()
- Returns:
serviceCategory(A broad categorization of the service that is to be performed during this appointment.)
-
setServiceCategory
public Slot setServiceCategory(List<CodeableConcept> theServiceCategory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasServiceCategory
public boolean hasServiceCategory()
-
addServiceCategory
public CodeableConcept addServiceCategory()
-
addServiceCategory
public Slot addServiceCategory(CodeableConcept t)
-
getServiceCategoryFirstRep
public CodeableConcept getServiceCategoryFirstRep()
- Returns:
- The first repetition of repeating field
serviceCategory, creating it if it does not already exist
-
getServiceType
public List<CodeableConcept> getServiceType()
- Returns:
serviceType(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.)
-
setServiceType
public Slot setServiceType(List<CodeableConcept> theServiceType)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasServiceType
public boolean hasServiceType()
-
addServiceType
public CodeableConcept addServiceType()
-
addServiceType
public Slot addServiceType(CodeableConcept t)
-
getServiceTypeFirstRep
public CodeableConcept getServiceTypeFirstRep()
- Returns:
- The first repetition of repeating field
serviceType, creating it if it does not already exist
-
getSpecialty
public List<CodeableConcept> getSpecialty()
- Returns:
specialty(The specialty of a practitioner that would be required to perform the service requested in this appointment.)
-
setSpecialty
public Slot setSpecialty(List<CodeableConcept> theSpecialty)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSpecialty
public boolean hasSpecialty()
-
addSpecialty
public CodeableConcept addSpecialty()
-
addSpecialty
public Slot addSpecialty(CodeableConcept t)
-
getSpecialtyFirstRep
public CodeableConcept getSpecialtyFirstRep()
- Returns:
- The first repetition of repeating field
specialty, creating it if it does not already exist
-
getAppointmentType
public CodeableConcept getAppointmentType()
- Returns:
appointmentType(The style of appointment or patient that may be booked in the slot (not service type).)
-
hasAppointmentType
public boolean hasAppointmentType()
-
setAppointmentType
public Slot setAppointmentType(CodeableConcept value)
- Parameters:
value-appointmentType(The style of appointment or patient that may be booked in the slot (not service type).)
-
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.)
-
getStatusElement
public Enumeration<Slot.SlotStatus> getStatusElement()
- Returns:
status(busy | free | busy-unavailable | busy-tentative | entered-in-error.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public Slot setStatusElement(Enumeration<Slot.SlotStatus> value)
- Parameters:
value-status(busy | free | busy-unavailable | busy-tentative | entered-in-error.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Slot.SlotStatus getStatus()
- Returns:
- busy | free | busy-unavailable | busy-tentative | entered-in-error.
-
setStatus
public Slot setStatus(Slot.SlotStatus value)
- Parameters:
value- busy | free | busy-unavailable | busy-tentative | entered-in-error.
-
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> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin 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
-
copyValues
public void copyValues(Slot dst)
-
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
-
-