public class Appointment extends BaseResource implements IResource
Definition:
Requirements:
Profile Definition: http://hl7.org/fhir/profiles/Appointment
| Modifier and Type | Class and Description |
|---|---|
static class |
Appointment.Participant
Block class for child element: Appointment.participant ()
|
| Modifier and Type | Field and Description |
|---|---|
static ReferenceClientParam |
ACTOR
Fluent Client search parameter constant for actor
|
static DateClientParam |
DATE
Fluent Client search parameter constant for date
|
static TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static Include |
INCLUDE_ACTOR
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PRACTITIONER
Constant for fluent queries to be used to add include statements.
|
static ReferenceClientParam |
LOCATION
Fluent Client search parameter constant for location
|
static TokenClientParam |
PART_STATUS
Fluent Client search parameter constant for part-status
|
static ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
static ReferenceClientParam |
PRACTITIONER
Fluent Client search parameter constant for practitioner
|
static String |
SP_ACTOR
Search parameter constant for actor
|
static String |
SP_DATE
Search parameter constant for date
|
static String |
SP_IDENTIFIER
Search parameter constant for identifier
|
static String |
SP_LOCATION
Search parameter constant for location
|
static String |
SP_PART_STATUS
Search parameter constant for part-status
|
static String |
SP_PATIENT
Search parameter constant for patient
|
static String |
SP_PRACTITIONER
Search parameter constant for practitioner
|
static String |
SP_STATUS
Search parameter constant for status
|
static TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
Appointment() |
| Modifier and Type | Method and Description |
|---|---|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier ()
|
Appointment |
addIdentifier(IdentifierDt theValue)
Adds a given new value for identifier ()
|
Appointment.Participant |
addParticipant()
Adds and returns a new value for participant ()
|
Appointment |
addParticipant(Appointment.Participant theValue)
Adds a given new value for participant ()
|
ResourceReferenceDt |
addSlot()
Adds and returns a new value for slot ()
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
String |
getComment()
Gets the value(s) for comment ().
|
StringDt |
getCommentElement()
Gets the value(s) for comment ().
|
String |
getDescription()
Gets the value(s) for description ().
|
StringDt |
getDescriptionElement()
Gets the value(s) for description ().
|
Date |
getEnd()
Gets the value(s) for end ().
|
InstantDt |
getEndElement()
Gets the value(s) for end ().
|
List<IdentifierDt> |
getIdentifier()
Gets the value(s) for identifier ().
|
IdentifierDt |
getIdentifierFirstRep()
Gets the first repetition for identifier (),
creating it if it does not already exist.
|
Integer |
getMinutesDuration()
Gets the value(s) for minutesDuration ().
|
PositiveIntDt |
getMinutesDurationElement()
Gets the value(s) for minutesDuration ().
|
List<Appointment.Participant> |
getParticipant()
Gets the value(s) for participant ().
|
Appointment.Participant |
getParticipantFirstRep()
Gets the first repetition for participant (),
creating it if it does not already exist.
|
Integer |
getPriority()
Gets the value(s) for priority ().
|
UnsignedIntDt |
getPriorityElement()
Gets the value(s) for priority ().
|
CodeableConceptDt |
getReason()
Gets the value(s) for reason ().
|
String |
getResourceName() |
List<ResourceReferenceDt> |
getSlot()
Gets the value(s) for slot ().
|
Date |
getStart()
Gets the value(s) for start ().
|
InstantDt |
getStartElement()
Gets the value(s) for start ().
|
String |
getStatus()
Gets the value(s) for status ().
|
BoundCodeDt<AppointmentStatusEnum> |
getStatusElement()
Gets the value(s) for status ().
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
CodeableConceptDt |
getType()
Gets the value(s) for type ().
|
boolean |
isEmpty() |
Appointment |
setComment(String theString)
Sets the value for comment ()
|
Appointment |
setComment(StringDt theValue)
Sets the value(s) for comment ()
|
Appointment |
setDescription(String theString)
Sets the value for description ()
|
Appointment |
setDescription(StringDt theValue)
Sets the value(s) for description ()
|
Appointment |
setEnd(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for end ()
|
Appointment |
setEnd(InstantDt theValue)
Sets the value(s) for end ()
|
Appointment |
setEndWithMillisPrecision(Date theDate)
Sets the value for end ()
|
Appointment |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier ()
|
Appointment |
setMinutesDuration(int theInteger)
Sets the value for minutesDuration ()
|
Appointment |
setMinutesDuration(PositiveIntDt theValue)
Sets the value(s) for minutesDuration ()
|
Appointment |
setParticipant(List<Appointment.Participant> theValue)
Sets the value(s) for participant ()
|
Appointment |
setPriority(int theInteger)
Sets the value for priority ()
|
Appointment |
setPriority(UnsignedIntDt theValue)
Sets the value(s) for priority ()
|
Appointment |
setReason(CodeableConceptDt theValue)
Sets the value(s) for reason ()
|
Appointment |
setSlot(List<ResourceReferenceDt> theValue)
Sets the value(s) for slot ()
|
Appointment |
setStart(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for start ()
|
Appointment |
setStart(InstantDt theValue)
Sets the value(s) for start ()
|
Appointment |
setStartWithMillisPrecision(Date theDate)
Sets the value for start ()
|
Appointment |
setStatus(AppointmentStatusEnum theValue)
Sets the value(s) for status ()
|
Appointment |
setStatus(BoundCodeDt<AppointmentStatusEnum> theValue)
Sets the value(s) for status ()
|
Appointment |
setType(CodeableConceptDt theValue)
Sets the value(s) for type ()
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_DATE
Description: Appointment date/time.
Type: date
Path: Appointment.start
public static final DateClientParam DATE
Description: Appointment date/time.
Type: date
Path: Appointment.start
public static final String SP_STATUS
Description: The overall status of the appointment
Type: token
Path: Appointment.status
public static final TokenClientParam STATUS
Description: The overall status of the appointment
Type: token
Path: Appointment.status
public static final String SP_ACTOR
Description: Any one of the individuals participating in the appointment
Type: reference
Path: Appointment.participant.actor
public static final ReferenceClientParam ACTOR
Description: Any one of the individuals participating in the appointment
Type: reference
Path: Appointment.participant.actor
public static final String SP_PART_STATUS
Description: The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.
Type: token
Path: Appointment.participant.status
public static final TokenClientParam PART_STATUS
Description: The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.
Type: token
Path: Appointment.participant.status
public static final String SP_PATIENT
Description: One of the individuals of the appointment is this patient
Type: reference
Path: Appointment.participant.actor
public static final ReferenceClientParam PATIENT
Description: One of the individuals of the appointment is this patient
Type: reference
Path: Appointment.participant.actor
public static final String SP_PRACTITIONER
Description: One of the individuals of the appointment is this practitioner
Type: reference
Path: Appointment.participant.actor
public static final ReferenceClientParam PRACTITIONER
Description: One of the individuals of the appointment is this practitioner
Type: reference
Path: Appointment.participant.actor
public static final String SP_LOCATION
Description: This location is listed in the participants of the appointment
Type: reference
Path: Appointment.participant.actor
public static final ReferenceClientParam LOCATION
Description: This location is listed in the participants of the appointment
Type: reference
Path: Appointment.participant.actor
public static final String SP_IDENTIFIER
Description: An Identifier of the Appointment
Type: token
Path: Appointment.identifier
public static final TokenClientParam IDENTIFIER
Description: An Identifier of the Appointment
Type: token
Path: Appointment.identifier
public static final Include INCLUDE_ACTOR
public static final Include INCLUDE_LOCATION
public static final Include INCLUDE_PATIENT
public static final Include INCLUDE_PRACTITIONER
public Appointment()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic List<IdentifierDt> getIdentifier()
null.
Definition: This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
public Appointment setIdentifier(List<IdentifierDt> theValue)
Definition: This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
public IdentifierDt addIdentifier()
Definition: This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
public Appointment addIdentifier(IdentifierDt theValue)
Definition: This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
theValue - The identifier to add (must not be null)public IdentifierDt getIdentifierFirstRep()
Definition: This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)
public BoundCodeDt<AppointmentStatusEnum> getStatusElement()
null.
Definition: The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status
public String getStatus()
null.
Definition: The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status
public Appointment setStatus(BoundCodeDt<AppointmentStatusEnum> theValue)
Definition: The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status
public Appointment setStatus(AppointmentStatusEnum theValue)
Definition: The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status
public CodeableConceptDt getType()
null.
Definition: The type of appointment that is being booked (This may also be associated with participants for location, and/or a HealthcareService)
public Appointment setType(CodeableConceptDt theValue)
Definition: The type of appointment that is being booked (This may also be associated with participants for location, and/or a HealthcareService)
public CodeableConceptDt getReason()
null.
Definition: The reason that this appointment is being scheduled. This is more clinical than administrative
public Appointment setReason(CodeableConceptDt theValue)
Definition: The reason that this appointment is being scheduled. This is more clinical than administrative
public UnsignedIntDt getPriorityElement()
null.
Definition: The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority)
public Integer getPriority()
null.
Definition: The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority)
public Appointment setPriority(UnsignedIntDt theValue)
Definition: The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority)
public Appointment setPriority(int theInteger)
Definition: The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority)
public StringDt getDescriptionElement()
null.
Definition: The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field
public String getDescription()
null.
Definition: The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field
public Appointment setDescription(StringDt theValue)
Definition: The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field
public Appointment setDescription(String theString)
Definition: The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field
public InstantDt getStartElement()
null.
Definition: Date/Time that the appointment is to take place
public Date getStart()
null.
Definition: Date/Time that the appointment is to take place
public Appointment setStart(InstantDt theValue)
Definition: Date/Time that the appointment is to take place
public Appointment setStartWithMillisPrecision(Date theDate)
Definition: Date/Time that the appointment is to take place
public Appointment setStart(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: Date/Time that the appointment is to take place
public InstantDt getEndElement()
null.
Definition: Date/Time that the appointment is to conclude
public Date getEnd()
null.
Definition: Date/Time that the appointment is to conclude
public Appointment setEnd(InstantDt theValue)
Definition: Date/Time that the appointment is to conclude
public Appointment setEndWithMillisPrecision(Date theDate)
Definition: Date/Time that the appointment is to conclude
public Appointment setEnd(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: Date/Time that the appointment is to conclude
public PositiveIntDt getMinutesDurationElement()
null.
Definition: Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request)
public Integer getMinutesDuration()
null.
Definition: Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request)
public Appointment setMinutesDuration(PositiveIntDt theValue)
Definition: Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request)
public Appointment setMinutesDuration(int theInteger)
Definition: Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request)
public List<ResourceReferenceDt> getSlot()
null.
Definition: The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot
public Appointment setSlot(List<ResourceReferenceDt> theValue)
Definition: The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot
public ResourceReferenceDt addSlot()
Definition: The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot
public StringDt getCommentElement()
null.
Definition: Additional comments about the appointment
public String getComment()
null.
Definition: Additional comments about the appointment
public Appointment setComment(StringDt theValue)
Definition: Additional comments about the appointment
public Appointment setComment(String theString)
Definition: Additional comments about the appointment
public List<Appointment.Participant> getParticipant()
null.
Definition: List of participants involved in the appointment
public Appointment setParticipant(List<Appointment.Participant> theValue)
Definition: List of participants involved in the appointment
public Appointment.Participant addParticipant()
Definition: List of participants involved in the appointment
public Appointment addParticipant(Appointment.Participant theValue)
Definition: List of participants involved in the appointment
theValue - The participant to add (must not be null)public Appointment.Participant getParticipantFirstRep()
Definition: List of participants involved in the appointment
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.