Class Schedule
- 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
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected BooleanType
Whether this schedule record is in active use or should not be used (such as was entered in error).static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for activeSlots that reference this schedule resource provide the availability details to these referenced resource(s).static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for actorThe actual objects that are the target of the reference (Slots that reference this schedule resource provide the availability details to these referenced resource(s).)protected StringType
Comments on the availability to describe any extended information.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for dateprotected List
<Identifier> External Ids for this item.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected Period
The period of time that the slots that reference this Schedule resource cover (even if none exist).static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for service-categorystatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for service-typeprotected List
<CodeableConcept> A broad categorization of the service that is to be performed during this appointment.protected List
<CodeableConcept> The specific service that is to be performed during this appointment.static final String
Search parameter: activestatic final String
Search parameter: actorstatic final String
Search parameter: datestatic final String
Search parameter: identifierstatic final String
Search parameter: service-categorystatic final String
Search parameter: service-typestatic final String
Search parameter: specialtyprotected List
<CodeableConcept> The specialty of a practitioner that would be required to perform the service requested in this appointment.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for specialtyFields 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
Fields 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_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddActor()
copy()
void
copyValues
(Schedule dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
boolean
getActor()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
hasActor()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setActive
(boolean value) setActiveElement
(BooleanType value) setComment
(String value) setCommentElement
(StringType value) setIdentifier
(List<Identifier> theIdentifier) setPlanningHorizon
(Period value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setServiceCategory
(List<CodeableConcept> theServiceCategory) setServiceType
(List<CodeableConcept> theServiceType) setSpecialty
(List<CodeableConcept> theSpecialty) protected Schedule
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, 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, getIdPart, 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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, 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
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
External Ids for this item. -
active
Whether this schedule record is in active use or should not be used (such as was entered in error). -
serviceCategory
A broad categorization of the service that is to be performed during this appointment. -
serviceType
The specific service that is to be performed during this appointment. -
specialty
The specialty of a practitioner that would be required to perform the service requested in this appointment. -
actor
Slots that reference this schedule resource provide the availability details to these referenced resource(s). -
actorTarget
The actual objects that are the target of the reference (Slots that reference this schedule resource provide the availability details to these referenced resource(s).) -
planningHorizon
The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates. -
comment
Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated. -
SP_ACTOR
Search parameter: actorDescription: The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for
Type: reference
Path: Schedule.actor
- See Also:
-
ACTOR
Fluent Client search parameter constant for actorDescription: The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for
Type: reference
Path: Schedule.actor
-
INCLUDE_ACTOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "Schedule:actor". -
SP_DATE
Search parameter: dateDescription: Search for Schedule resources that have a period that contains this date specified
Type: date
Path: Schedule.planningHorizon
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: Search for Schedule resources that have a period that contains this date specified
Type: date
Path: Schedule.planningHorizon
-
SP_IDENTIFIER
Search parameter: identifierDescription: A Schedule Identifier
Type: token
Path: Schedule.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: A Schedule Identifier
Type: token
Path: Schedule.identifier
-
SP_SPECIALTY
Search parameter: specialtyDescription: Type of specialty needed
Type: token
Path: Schedule.specialty
- See Also:
-
SPECIALTY
Fluent Client search parameter constant for specialtyDescription: Type of specialty needed
Type: token
Path: Schedule.specialty
-
SP_SERVICE_CATEGORY
Search parameter: service-categoryDescription: High-level category
Type: token
Path: Schedule.serviceCategory
- See Also:
-
SERVICE_CATEGORY
Fluent Client search parameter constant for service-categoryDescription: High-level category
Type: token
Path: Schedule.serviceCategory
-
SP_SERVICE_TYPE
Search parameter: service-typeDescription: The type of appointments that can be booked into associated slot(s)
Type: token
Path: Schedule.serviceType
- See Also:
-
SERVICE_TYPE
Fluent Client search parameter constant for service-typeDescription: The type of appointments that can be booked into associated slot(s)
Type: token
Path: Schedule.serviceType
-
SP_ACTIVE
Search parameter: activeDescription: Is the schedule in active use
Type: token
Path: Schedule.active
- See Also:
-
ACTIVE
Fluent Client search parameter constant for activeDescription: Is the schedule in active use
Type: token
Path: Schedule.active
-
-
Constructor Details
-
Schedule
public Schedule()Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(External Ids for this item.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getActiveElement
- Returns:
active
(Whether this schedule record is in active use or should not be used (such as was entered in error).). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value
-
hasActiveElement
-
hasActive
-
setActiveElement
- Parameters:
value
-active
(Whether this schedule record is in active use or should not be used (such as was entered in error).). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value
-
getActive
- Returns:
- Whether this schedule record is in active use or should not be used (such as was entered in error).
-
setActive
- Parameters:
value
- Whether this schedule record is in active use or should not be used (such as was entered in error).
-
getServiceCategory
- Returns:
serviceCategory
(A broad categorization of the service that is to be performed during this appointment.)
-
setServiceCategory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasServiceCategory
-
addServiceCategory
-
addServiceCategory
-
getServiceCategoryFirstRep
- Returns:
- The first repetition of repeating field
serviceCategory
, creating it if it does not already exist
-
getServiceType
- Returns:
serviceType
(The specific service that is to be performed during this appointment.)
-
setServiceType
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasServiceType
-
addServiceType
-
addServiceType
-
getServiceTypeFirstRep
- Returns:
- The first repetition of repeating field
serviceType
, creating it if it does not already exist
-
getSpecialty
- Returns:
specialty
(The specialty of a practitioner that would be required to perform the service requested in this appointment.)
-
setSpecialty
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSpecialty
-
addSpecialty
-
addSpecialty
-
getSpecialtyFirstRep
- Returns:
- The first repetition of repeating field
specialty
, creating it if it does not already exist
-
getActor
- Returns:
actor
(Slots that reference this schedule resource provide the availability details to these referenced resource(s).)
-
setActor
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasActor
-
addActor
-
addActor
-
getActorFirstRep
- Returns:
- The first repetition of repeating field
actor
, creating it if it does not already exist
-
getActorTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getPlanningHorizon
- Returns:
planningHorizon
(The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.)
-
hasPlanningHorizon
-
setPlanningHorizon
- Parameters:
value
-planningHorizon
(The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.)
-
getCommentElement
- Returns:
comment
(Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.). 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 availability to describe any extended information. Such as custom constraints on the slots that may be associated.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value
-
getComment
- Returns:
- Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.
-
setComment
- Parameters:
value
- Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-