Package ca.uhn.fhir.model.dstu2.resource

Class Schedule

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.dstu2.resource.BaseResource

ca.uhn.fhir.model.dstu2.resource.Schedule

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 Schedule
extends BaseResource
implements ca.uhn.fhir.model.api.IResource

HAPI/FHIR Schedule Resource (workflow.scheduling)

Definition: A container for slot(s) of time that may be available for booking appointments.

Requirements:

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

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ACTOR	Fluent Client search parameter constant for actor
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_ACTOR	Constant for fluent queries to be used to add include statements.
static final String	SP_ACTOR	Search parameter constant for actor
static final String	SP_DATE	Search parameter constant for date
static final String	SP_IDENTIFIER	Search parameter constant for identifier
static final String	SP_TYPE	Search parameter constant for type
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type

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

RES_ID, SP_RES_ID

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Schedule()

Method Summary

Modifier and Type	Method	Description
IdentifierDt	addIdentifier()	Adds and returns a new value for identifier (id)
Schedule	addIdentifier(IdentifierDt theValue)	Adds a given new value for identifier (id)
CodeableConceptDt	addType()	Adds and returns a new value for type (class)
Schedule	addType(CodeableConceptDt theValue)	Adds a given new value for type (class)
ResourceReferenceDt	getActor()	Gets the value(s) for actor (who.focus).
<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 ().
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.
PeriodDt	getPlanningHorizon()	Gets the value(s) for planningHorizon (when.planned).
String	getResourceName()
ca.uhn.fhir.context.FhirVersionEnum	getStructureFhirVersionEnum()
List<CodeableConceptDt>	getType()	Gets the value(s) for type (class).
CodeableConceptDt	getTypeFirstRep()	Gets the first repetition for type (class), creating it if it does not already exist.
boolean	isEmpty()
Schedule	setActor(ResourceReferenceDt theValue)	Sets the value(s) for actor (who.focus)
Schedule	setComment(ca.uhn.fhir.model.primitive.StringDt theValue)	Sets the value(s) for comment ()
Schedule	setComment(String theString)	Sets the value for comment ()
Schedule	setIdentifier(List<IdentifierDt> theValue)	Sets the value(s) for identifier (id)
Schedule	setPlanningHorizon(PeriodDt theValue)	Sets the value(s) for planningHorizon (when.planned)
Schedule	setType(List<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, getUserData, hasFormatComment, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

getIdElement, setId, setId

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

getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Field Details

SP_ACTOR

public static final String SP_ACTOR

Search parameter constant for actor

Description: The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for
Type: reference
Path: Schedule.actor

See Also:

• Constant Field Values

ACTOR

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ACTOR

Fluent Client search parameter constant for actor

Description: The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for
Type: reference
Path: Schedule.actor

SP_TYPE

public static final String SP_TYPE

Search parameter constant for type

Description: The type of appointments that can be booked into associated slot(s)
Type: token
Path: Schedule.type

See Also:

• Constant Field Values

TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE

Fluent Client search parameter constant for type

Description: The type of appointments that can be booked into associated slot(s)
Type: token
Path: Schedule.type

SP_DATE

public static final String SP_DATE

Search parameter constant for date

Description: Search for Schedule resources that have a period that contains this date specified
Type: date
Path: Schedule.planningHorizon

See Also:

• Constant Field Values

DATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE

Fluent Client search parameter constant for date

Description: Search for Schedule resources that have a period that contains this date specified
Type: date
Path: Schedule.planningHorizon

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter constant for identifier

Description: A Schedule Identifier
Type: token
Path: Schedule.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 Schedule Identifier
Type: token
Path: Schedule.identifier

INCLUDE_ACTOR

public static final ca.uhn.fhir.model.api.Include INCLUDE_ACTOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "Schedule:actor".

Constructor Details

Schedule

public Schedule()

Method Details

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 Schedule 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 Schedule 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 List<CodeableConceptDt> getType()

Gets the value(s) for type (class). creating it if it does not exist. Will not return null.

Definition:

setType

public Schedule setType(List<CodeableConceptDt> theValue)

Sets the value(s) for type (class)

Definition:

addType

public CodeableConceptDt addType()

Adds and returns a new value for type (class)

Definition:

addType

public Schedule addType(CodeableConceptDt theValue)

Adds a given new value for type (class)

Definition:

Parameters:

theValue - The type to add (must not be null)

getTypeFirstRep

public CodeableConceptDt getTypeFirstRep()

Gets the first repetition for type (class), creating it if it does not already exist.

Definition:

getActor

public ResourceReferenceDt getActor()

Gets the value(s) for actor (who.focus). creating it if it does not exist. Will not return null.

Definition:

setActor

public Schedule setActor(ResourceReferenceDt theValue)

Sets the value(s) for actor (who.focus)

Definition:

getPlanningHorizon

public PeriodDt getPlanningHorizon()

Gets the value(s) for planningHorizon (when.planned). creating it if it does not exist. Will not return null.

Definition:

setPlanningHorizon

public Schedule setPlanningHorizon(PeriodDt theValue)

Sets the value(s) for planningHorizon (when.planned)

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 Schedule setComment(ca.uhn.fhir.model.primitive.StringDt theValue)

Sets the value(s) for comment ()

Definition:

setComment

public Schedule 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 org.hl7.fhir.instance.model.api.IBaseResource

Specified by:

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