Class Appointment
- 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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static enum
static class
static enum
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for actorstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for appointment-typeprotected CodeableConcept
The style of appointment or patient that has been booked in the slot (not service type).static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for based-onThe service request this appointment is allocated to assess (e.g.protected List
<ServiceRequest> The actual objects that are the target of the reference (The service request this appointment is allocated to assess (e.g.protected CodeableConcept
The coded reason for the appointment being cancelled.protected StringType
Additional comments about the appointment.protected DateTimeType
The date that this appointment was initially created.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for dateprotected StringType
The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list.protected InstantType
Date/Time that the appointment is to conclude.protected List
<Identifier> 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.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.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for locationprotected PositiveIntType
Number of minutes that the appointment is to take.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for part-statusprotected List
<Appointment.AppointmentParticipantComponent> List of participants involved in the appointment.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected StringType
While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for practitionerprotected UnsignedIntType
The priority of the appointment.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for reason-codestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for reason-referenceprotected List
<CodeableConcept> The coded reason that this appointment is being scheduled.Reason the appointment has been scheduled to take place, as specified using information from another resource.The actual objects that are the target of the reference (Reason the appointment has been scheduled to take place, as specified using information from another resource.A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.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.The slots from the participants' schedules that will be filled by the appointment.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for slotThe actual objects that are the target of the reference (The slots from the participants' schedules that will be filled by the appointment.)static final String
Search parameter: actorstatic final String
Search parameter: appointment-typestatic final String
Search parameter: based-onstatic final String
Search parameter: datestatic final String
Search parameter: identifierstatic final String
Search parameter: locationstatic final String
Search parameter: part-statusstatic final String
Search parameter: patientstatic final String
Search parameter: practitionerstatic final String
Search parameter: reason-codestatic final String
Search parameter: reason-referencestatic final String
Search parameter: service-categorystatic final String
Search parameter: service-typestatic final String
Search parameter: slotstatic final String
Search parameter: specialtystatic final String
Search parameter: statusstatic final String
Search parameter: supporting-infoprotected 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 specialtyprotected InstantType
Date/Time that the appointment is to take place.protected Enumeration
<Appointment.AppointmentStatus> The overall status of the Appointment.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for supporting-infoAdditional information to support the appointment provided when making the appointment.The actual objects that are the target of the reference (Additional information to support the appointment provided when making the appointment.)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
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
ConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Use Reference#setResource(IBaseResource) insteadaddSlot()
Deprecated.Use Reference#setResource(IBaseResource) insteadcopy()
void
copyValues
(Appointment dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetEnd()
int
getNamedProperty
(int _hash, String _name, boolean _checkValid) int
Base[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadgetSlot()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetStart()
Deprecated.Use Reference#setResource(IBaseResource) insteadString[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasEnd()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasSlot()
boolean
boolean
hasStart()
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setBasedOn
(List<Reference> theBasedOn) setComment
(String value) setCommentElement
(StringType value) setCreated
(Date value) setCreatedElement
(DateTimeType value) setDescription
(String value) setDescriptionElement
(StringType value) setEndElement
(InstantType value) setIdentifier
(List<Identifier> theIdentifier) setMinutesDuration
(int value) setParticipant
(List<Appointment.AppointmentParticipantComponent> theParticipant) setPatientInstruction
(String value) setPriority
(int value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReasonCode
(List<CodeableConcept> theReasonCode) setReasonReference
(List<Reference> theReasonReference) setRequestedPeriod
(List<Period> theRequestedPeriod) setServiceCategory
(List<CodeableConcept> theServiceCategory) setServiceType
(List<CodeableConcept> theServiceType) setSpecialty
(List<CodeableConcept> theSpecialty) setStartElement
(InstantType value) setSupportingInformation
(List<Reference> theSupportingInformation) protected Appointment
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
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). -
status
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. -
cancelationReason
The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply. -
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. -
appointmentType
The style of appointment or patient that has been booked in the slot (not service type). -
reasonCode
The coded reason that this appointment is being scheduled. This is more clinical than administrative. -
reasonReference
Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. -
reasonReferenceTarget
The actual objects that are the target of the reference (Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.) -
priority
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). -
description
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. -
supportingInformation
Additional information to support the appointment provided when making the appointment. -
supportingInformationTarget
The actual objects that are the target of the reference (Additional information to support the appointment provided when making the appointment.) -
start
Date/Time that the appointment is to take place. -
end
Date/Time that the appointment is to conclude. -
minutesDuration
Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end. -
slot
The slots from the participants' schedules that will be filled by the appointment. -
slotTarget
The actual objects that are the target of the reference (The slots from the participants' schedules that will be filled by the appointment.) -
created
The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment. -
comment
Additional comments about the appointment. -
patientInstruction
While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before). -
basedOn
The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). -
basedOnTarget
The actual objects that are the target of the reference (The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).) -
participant
List of participants involved in the appointment. -
requestedPeriod
A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system. -
SP_DATE
Search parameter: dateDescription: Appointment date/time.
Type: date
Path: Appointment.start
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: Appointment date/time.
Type: date
Path: Appointment.start
-
SP_IDENTIFIER
Search parameter: identifierDescription: An Identifier of the Appointment
Type: token
Path: Appointment.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: An Identifier of the Appointment
Type: token
Path: Appointment.identifier
-
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: Appointment.specialty
- See Also:
-
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: Appointment.specialty
-
SP_SERVICE_CATEGORY
Search parameter: service-categoryDescription: A broad categorization of the service that is to be performed during this appointment
Type: token
Path: Appointment.serviceCategory
- See Also:
-
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: Appointment.serviceCategory
-
SP_PRACTITIONER
Search parameter: practitionerDescription: One of the individuals of the appointment is this practitioner
Type: reference
Path: Appointment.participant.actor
- See Also:
-
PRACTITIONER
Fluent Client search parameter constant for practitionerDescription: One of the individuals of the appointment is this practitioner
Type: reference
Path: Appointment.participant.actor
-
INCLUDE_PRACTITIONER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:practitioner". -
SP_PART_STATUS
Search parameter: part-statusDescription: 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
- See Also:
-
PART_STATUS
Fluent Client search parameter constant for part-statusDescription: 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
-
SP_APPOINTMENT_TYPE
Search parameter: appointment-typeDescription: The style of appointment or patient that has been booked in the slot (not service type)
Type: token
Path: Appointment.appointmentType
- See Also:
-
APPOINTMENT_TYPE
Fluent Client search parameter constant for appointment-typeDescription: The style of appointment or patient that has been booked in the slot (not service type)
Type: token
Path: Appointment.appointmentType
-
SP_SERVICE_TYPE
Search parameter: service-typeDescription: The specific service that is to be performed during this appointment
Type: token
Path: Appointment.serviceType
- See Also:
-
SERVICE_TYPE
Fluent Client search parameter constant for service-typeDescription: The specific service that is to be performed during this appointment
Type: token
Path: Appointment.serviceType
-
SP_SLOT
Search parameter: slotDescription: The slots that this appointment is filling
Type: reference
Path: Appointment.slot
- See Also:
-
SLOT
Fluent Client search parameter constant for slotDescription: The slots that this appointment is filling
Type: reference
Path: Appointment.slot
-
INCLUDE_SLOT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:slot". -
SP_REASON_CODE
Search parameter: reason-codeDescription: Coded reason this appointment is scheduled
Type: token
Path: Appointment.reasonCode
- See Also:
-
REASON_CODE
Fluent Client search parameter constant for reason-codeDescription: Coded reason this appointment is scheduled
Type: token
Path: Appointment.reasonCode
-
SP_ACTOR
Search parameter: actorDescription: Any one of the individuals participating in the appointment
Type: reference
Path: Appointment.participant.actor
- See Also:
-
ACTOR
Fluent Client search parameter constant for actorDescription: Any one of the individuals participating in the appointment
Type: reference
Path: Appointment.participant.actor
-
INCLUDE_ACTOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:actor". -
SP_BASED_ON
Search parameter: based-onDescription: The service request this appointment is allocated to assess
Type: reference
Path: Appointment.basedOn
- See Also:
-
BASED_ON
Fluent Client search parameter constant for based-onDescription: The service request this appointment is allocated to assess
Type: reference
Path: Appointment.basedOn
-
INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:based-on". -
SP_PATIENT
Search parameter: patientDescription: One of the individuals of the appointment is this patient
Type: reference
Path: Appointment.participant.actor
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: One of the individuals of the appointment is this patient
Type: reference
Path: Appointment.participant.actor
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:patient". -
SP_REASON_REFERENCE
Search parameter: reason-referenceDescription: Reason the appointment is to take place (resource)
Type: reference
Path: Appointment.reasonReference
- See Also:
-
REASON_REFERENCE
Fluent Client search parameter constant for reason-referenceDescription: Reason the appointment is to take place (resource)
Type: reference
Path: Appointment.reasonReference
-
INCLUDE_REASON_REFERENCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:reason-reference". -
SP_SUPPORTING_INFO
Search parameter: supporting-infoDescription: Additional information to support the appointment
Type: reference
Path: Appointment.supportingInformation
- See Also:
-
SUPPORTING_INFO
Fluent Client search parameter constant for supporting-infoDescription: Additional information to support the appointment
Type: reference
Path: Appointment.supportingInformation
-
INCLUDE_SUPPORTING_INFO
Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:supporting-info". -
SP_LOCATION
Search parameter: locationDescription: This location is listed in the participants of the appointment
Type: reference
Path: Appointment.participant.actor
- See Also:
-
LOCATION
Fluent Client search parameter constant for locationDescription: This location is listed in the participants of the appointment
Type: reference
Path: Appointment.participant.actor
-
INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Appointment:location". -
SP_STATUS
Search parameter: statusDescription: The overall status of the appointment
Type: token
Path: Appointment.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The overall status of the appointment
Type: token
Path: Appointment.status
-
-
Constructor Details
-
Appointment
public Appointment()Constructor -
Appointment
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(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).)
-
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
-
getStatusElement
- Returns:
status
(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.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
-
hasStatus
-
setStatusElement
- Parameters:
value
-status
(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.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- 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.
-
setStatus
- Parameters:
value
- 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.
-
getCancelationReason
- Returns:
cancelationReason
(The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.)
-
hasCancelationReason
-
setCancelationReason
- Parameters:
value
-cancelationReason
(The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.)
-
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
-
getAppointmentType
- Returns:
appointmentType
(The style of appointment or patient that has been booked in the slot (not service type).)
-
hasAppointmentType
-
setAppointmentType
- Parameters:
value
-appointmentType
(The style of appointment or patient that has been booked in the slot (not service type).)
-
getReasonCode
- Returns:
reasonCode
(The coded reason that this appointment is being scheduled. This is more clinical than administrative.)
-
setReasonCode
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonCode
-
addReasonCode
-
addReasonCode
-
getReasonCodeFirstRep
- Returns:
- The first repetition of repeating field
reasonCode
, creating it if it does not already exist
-
getReasonReference
- Returns:
reasonReference
(Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.)
-
setReasonReference
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonReference
-
addReasonReference
-
addReasonReference
-
getReasonReferenceFirstRep
- Returns:
- The first repetition of repeating field
reasonReference
, creating it if it does not already exist
-
getReasonReferenceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getPriorityElement
- Returns:
priority
(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).). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
hasPriorityElement
-
hasPriority
-
setPriorityElement
- Parameters:
value
-priority
(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).). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
getPriority
- Returns:
- 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).
-
setPriority
- Parameters:
value
- 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).
-
getDescriptionElement
- Returns:
description
(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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
-
hasDescription
-
setDescriptionElement
- Parameters:
value
-description
(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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
- Returns:
- 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.
-
setDescription
- Parameters:
value
- 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.
-
getSupportingInformation
- Returns:
supportingInformation
(Additional information to support the appointment provided when making the appointment.)
-
setSupportingInformation
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSupportingInformation
-
addSupportingInformation
-
addSupportingInformation
-
getSupportingInformationFirstRep
- Returns:
- The first repetition of repeating field
supportingInformation
, creating it if it does not already exist
-
getSupportingInformationTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getStartElement
- Returns:
start
(Date/Time that the appointment is to take place.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value
-
hasStartElement
-
hasStart
-
setStartElement
- Parameters:
value
-start
(Date/Time that the appointment is to take place.). This is the underlying object with id, value and extensions. The accessor "getStart" gives direct access to the value
-
getStart
- Returns:
- Date/Time that the appointment is to take place.
-
setStart
- Parameters:
value
- Date/Time that the appointment is to take place.
-
getEndElement
- Returns:
end
(Date/Time that the appointment is to conclude.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value
-
hasEndElement
-
hasEnd
-
setEndElement
- Parameters:
value
-end
(Date/Time that the appointment is to conclude.). This is the underlying object with id, value and extensions. The accessor "getEnd" gives direct access to the value
-
getEnd
- Returns:
- Date/Time that the appointment is to conclude.
-
setEnd
- Parameters:
value
- Date/Time that the appointment is to conclude.
-
getMinutesDurationElement
- Returns:
minutesDuration
(Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.). This is the underlying object with id, value and extensions. The accessor "getMinutesDuration" gives direct access to the value
-
hasMinutesDurationElement
-
hasMinutesDuration
-
setMinutesDurationElement
- Parameters:
value
-minutesDuration
(Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.). This is the underlying object with id, value and extensions. The accessor "getMinutesDuration" gives direct access to the value
-
getMinutesDuration
- Returns:
- Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
-
setMinutesDuration
- Parameters:
value
- Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
-
getSlot
- Returns:
slot
(The slots from the participants' schedules that will be filled by the appointment.)
-
setSlot
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSlot
-
addSlot
-
addSlot
-
getSlotFirstRep
- Returns:
- The first repetition of repeating field
slot
, creating it if it does not already exist
-
getSlotTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addSlotTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getCreatedElement
- Returns:
created
(The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value
-
hasCreatedElement
-
hasCreated
-
setCreatedElement
- Parameters:
value
-created
(The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value
-
getCreated
- Returns:
- The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
-
setCreated
- Parameters:
value
- The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
-
getCommentElement
- Returns:
comment
(Additional comments about the appointment.). 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
(Additional comments about the appointment.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value
-
getComment
- Returns:
- Additional comments about the appointment.
-
setComment
- Parameters:
value
- Additional comments about the appointment.
-
getPatientInstructionElement
- Returns:
patientInstruction
(While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).). This is the underlying object with id, value and extensions. The accessor "getPatientInstruction" gives direct access to the value
-
hasPatientInstructionElement
-
hasPatientInstruction
-
setPatientInstructionElement
- Parameters:
value
-patientInstruction
(While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).). This is the underlying object with id, value and extensions. The accessor "getPatientInstruction" gives direct access to the value
-
getPatientInstruction
- Returns:
- While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
-
setPatientInstruction
- Parameters:
value
- While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
-
getBasedOn
- Returns:
basedOn
(The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).)
-
setBasedOn
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBasedOn
-
addBasedOn
-
addBasedOn
-
getBasedOnFirstRep
- Returns:
- The first repetition of repeating field
basedOn
, creating it if it does not already exist
-
getBasedOnTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addBasedOnTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getParticipant
- Returns:
participant
(List of participants involved in the appointment.)
-
setParticipant
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasParticipant
-
addParticipant
-
addParticipant
-
getParticipantFirstRep
- Returns:
- The first repetition of repeating field
participant
, creating it if it does not already exist
-
getRequestedPeriod
- Returns:
requestedPeriod
(A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.)
-
setRequestedPeriod
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRequestedPeriod
-
addRequestedPeriod
-
addRequestedPeriod
-
getRequestedPeriodFirstRep
- Returns:
- The first repetition of repeating field
requestedPeriod
, creating it if it does not already exist
-
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
-