public class Appointment extends DomainResource
| Modifier and Type | Class and Description |
|---|---|
static class |
Appointment.AppointmentParticipantComponent |
static class |
Appointment.AppointmentStatus |
static class |
Appointment.AppointmentStatusEnumFactory |
static class |
Appointment.ParticipantRequired |
static class |
Appointment.ParticipantRequiredEnumFactory |
static class |
Appointment.ParticipationStatus |
static class |
Appointment.ParticipationStatusEnumFactory |
| Modifier and Type | Field and Description |
|---|---|
static ReferenceClientParam |
ACTOR
Fluent Client search parameter constant for actor
|
static TokenClientParam |
APPOINTMENT_TYPE
Fluent Client search parameter constant for appointment-type
|
protected CodeableConcept |
appointmentType
The style of appointment or patient that has been booked in the slot (not service type).
|
protected StringType |
comment
Additional comments about the appointment.
|
protected DateTimeType |
created
The date that this appointment was initially created.
|
static DateClientParam |
DATE
Fluent Client search parameter constant for date
|
protected StringType |
description
The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list.
|
protected InstantType |
end
Date/Time that the appointment is to conclude.
|
protected List<Identifier> |
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 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_INCOMINGREFERRAL
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.
|
protected List<Reference> |
incomingReferral
The referral request this appointment is allocated to assess (incoming referral).
|
static ReferenceClientParam |
INCOMINGREFERRAL
Fluent Client search parameter constant for incomingreferral
|
protected List<ReferralRequest> |
incomingReferralTarget
The actual objects that are the target of the reference (The referral request this appointment is allocated to assess (incoming referral).)
|
protected List<Reference> |
indication
Reason the appointment has been scheduled to take place, as specified using information from another resource.
|
protected List<Resource> |
indicationTarget
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.
|
static ReferenceClientParam |
LOCATION
Fluent Client search parameter constant for location
|
protected PositiveIntType |
minutesDuration
Number of minutes that the appointment is to take.
|
static TokenClientParam |
PART_STATUS
Fluent Client search parameter constant for part-status
|
protected List<Appointment.AppointmentParticipantComponent> |
participant
List of participants involved in the appointment.
|
static ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
static ReferenceClientParam |
PRACTITIONER
Fluent Client search parameter constant for practitioner
|
protected UnsignedIntType |
priority
The priority of the appointment.
|
protected List<CodeableConcept> |
reason
The reason that this appointment is being scheduled.
|
protected List<Period> |
requestedPeriod
A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.
|
static TokenClientParam |
SERVICE_TYPE
Fluent Client search parameter constant for service-type
|
protected CodeableConcept |
serviceCategory
A broad categorisation of the service that is to be performed during this appointment.
|
protected List<CodeableConcept> |
serviceType
The specific service that is to be performed during this appointment.
|
protected List<Reference> |
slot
The slots from the participants' schedules that will be filled by the appointment.
|
protected List<Slot> |
slotTarget
The actual objects that are the target of the reference (The slots from the participants' schedules that will be filled by the appointment.)
|
static String |
SP_ACTOR
Search parameter: actor
|
static String |
SP_APPOINTMENT_TYPE
Search parameter: appointment-type
|
static String |
SP_DATE
Search parameter: date
|
static String |
SP_IDENTIFIER
Search parameter: identifier
|
static String |
SP_INCOMINGREFERRAL
Search parameter: incomingreferral
|
static String |
SP_LOCATION
Search parameter: location
|
static String |
SP_PART_STATUS
Search parameter: part-status
|
static String |
SP_PATIENT
Search parameter: patient
|
static String |
SP_PRACTITIONER
Search parameter: practitioner
|
static String |
SP_SERVICE_TYPE
Search parameter: service-type
|
static String |
SP_STATUS
Search parameter: status
|
protected List<CodeableConcept> |
specialty
The specialty of a practitioner that would be required to perform the service requested in this appointment.
|
protected InstantType |
start
Date/Time that the appointment is to take place.
|
protected Enumeration<Appointment.AppointmentStatus> |
status
The overall status of the Appointment.
|
static TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
protected List<Reference> |
supportingInformation
Additional information to support the appointment provided when making the appointment.
|
protected List<Resource> |
supportingInformationTarget
The actual objects that are the target of the reference (Additional information to support the appointment provided when making the appointment.)
|
contained, extension, modifierExtension, textid, implicitRules, language, metaRES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
Appointment()
Constructor
|
Appointment(Enumeration<Appointment.AppointmentStatus> status)
Constructor
|
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setTextcopyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, isResource, setIdcastToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDatagetMeta, getStructureFhirVersionEnum, setIdgetFormatCommentsPost, getFormatCommentsPre, hasFormatCommentprotected List<Identifier> identifier
protected Enumeration<Appointment.AppointmentStatus> status
protected CodeableConcept serviceCategory
protected List<CodeableConcept> serviceType
protected List<CodeableConcept> specialty
protected CodeableConcept appointmentType
protected List<CodeableConcept> reason
protected List<Reference> indication
protected List<Resource> indicationTarget
protected UnsignedIntType priority
protected StringType description
protected List<Reference> supportingInformation
protected List<Resource> supportingInformationTarget
protected InstantType start
protected InstantType end
protected PositiveIntType minutesDuration
protected List<Reference> slot
protected List<Slot> slotTarget
protected DateTimeType created
protected StringType comment
protected List<Reference> incomingReferral
protected List<ReferralRequest> incomingReferralTarget
protected List<Appointment.AppointmentParticipantComponent> participant
protected List<Period> requestedPeriod
public 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_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 Include INCLUDE_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 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 Include INCLUDE_PRACTITIONER
public static final String SP_INCOMINGREFERRAL
Description: The ReferralRequest provided as information to allocate to the Encounter
Type: reference
Path: Appointment.incomingReferral
public static final ReferenceClientParam INCOMINGREFERRAL
Description: The ReferralRequest provided as information to allocate to the Encounter
Type: reference
Path: Appointment.incomingReferral
public static final Include INCLUDE_INCOMINGREFERRAL
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 Include INCLUDE_PATIENT
public static final String SP_APPOINTMENT_TYPE
Description: The style of appointment or patient that has been booked in the slot (not service type)
Type: token
Path: Appointment.appointmentType
public static final TokenClientParam APPOINTMENT_TYPE
Description: The style of appointment or patient that has been booked in the slot (not service type)
Type: token
Path: Appointment.appointmentType
public static final String SP_SERVICE_TYPE
Description: The specific service that is to be performed during this appointment
Type: token
Path: Appointment.serviceType
public static final TokenClientParam SERVICE_TYPE
Description: The specific service that is to be performed during this appointment
Type: token
Path: Appointment.serviceType
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 Include INCLUDE_LOCATION
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 Appointment()
public Appointment(Enumeration<Appointment.AppointmentStatus> status)
public List<Identifier> getIdentifier()
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).)public Appointment setIdentifier(List<Identifier> theIdentifier)
this for easy method chainingpublic boolean hasIdentifier()
public Identifier addIdentifier()
public Appointment addIdentifier(Identifier t)
public Identifier getIdentifierFirstRep()
identifier, creating it if it does not already existpublic Enumeration<Appointment.AppointmentStatus> getStatusElement()
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 valuepublic boolean hasStatusElement()
public boolean hasStatus()
public Appointment setStatusElement(Enumeration<Appointment.AppointmentStatus> value)
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 valuepublic Appointment.AppointmentStatus getStatus()
public Appointment setStatus(Appointment.AppointmentStatus value)
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.public CodeableConcept getServiceCategory()
serviceCategory (A broad categorisation of the service that is to be performed during this appointment.)public boolean hasServiceCategory()
public Appointment setServiceCategory(CodeableConcept value)
value - serviceCategory (A broad categorisation of the service that is to be performed during this appointment.)public List<CodeableConcept> getServiceType()
serviceType (The specific service that is to be performed during this appointment.)public Appointment setServiceType(List<CodeableConcept> theServiceType)
this for easy method chainingpublic boolean hasServiceType()
public CodeableConcept addServiceType()
public Appointment addServiceType(CodeableConcept t)
public CodeableConcept getServiceTypeFirstRep()
serviceType, creating it if it does not already existpublic List<CodeableConcept> getSpecialty()
specialty (The specialty of a practitioner that would be required to perform the service requested in this appointment.)public Appointment setSpecialty(List<CodeableConcept> theSpecialty)
this for easy method chainingpublic boolean hasSpecialty()
public CodeableConcept addSpecialty()
public Appointment addSpecialty(CodeableConcept t)
public CodeableConcept getSpecialtyFirstRep()
specialty, creating it if it does not already existpublic CodeableConcept getAppointmentType()
appointmentType (The style of appointment or patient that has been booked in the slot (not service type).)public boolean hasAppointmentType()
public Appointment setAppointmentType(CodeableConcept value)
value - appointmentType (The style of appointment or patient that has been booked in the slot (not service type).)public List<CodeableConcept> getReason()
reason (The reason that this appointment is being scheduled. This is more clinical than administrative.)public Appointment setReason(List<CodeableConcept> theReason)
this for easy method chainingpublic boolean hasReason()
public CodeableConcept addReason()
public Appointment addReason(CodeableConcept t)
public CodeableConcept getReasonFirstRep()
reason, creating it if it does not already existpublic List<Reference> getIndication()
indication (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.)public Appointment setIndication(List<Reference> theIndication)
this for easy method chainingpublic boolean hasIndication()
public Reference addIndication()
public Appointment addIndication(Reference t)
public Reference getIndicationFirstRep()
indication, creating it if it does not already exist@Deprecated public List<Resource> getIndicationTarget()
public UnsignedIntType getPriorityElement()
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 valuepublic boolean hasPriorityElement()
public boolean hasPriority()
public Appointment setPriorityElement(UnsignedIntType value)
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 valuepublic int getPriority()
public Appointment setPriority(int value)
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).public StringType getDescriptionElement()
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 valuepublic boolean hasDescriptionElement()
public boolean hasDescription()
public Appointment setDescriptionElement(StringType value)
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 valuepublic String getDescription()
public Appointment setDescription(String value)
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.public List<Reference> getSupportingInformation()
supportingInformation (Additional information to support the appointment provided when making the appointment.)public Appointment setSupportingInformation(List<Reference> theSupportingInformation)
this for easy method chainingpublic boolean hasSupportingInformation()
public Reference addSupportingInformation()
public Appointment addSupportingInformation(Reference t)
public Reference getSupportingInformationFirstRep()
supportingInformation, creating it if it does not already exist@Deprecated public List<Resource> getSupportingInformationTarget()
public InstantType getStartElement()
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 valuepublic boolean hasStartElement()
public boolean hasStart()
public Appointment setStartElement(InstantType value)
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 valuepublic Appointment setStart(Date value)
value - Date/Time that the appointment is to take place.public InstantType getEndElement()
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 valuepublic boolean hasEndElement()
public boolean hasEnd()
public Appointment setEndElement(InstantType value)
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 valuepublic Appointment setEnd(Date value)
value - Date/Time that the appointment is to conclude.public PositiveIntType getMinutesDurationElement()
minutesDuration (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).). This is the underlying object with id, value and extensions. The accessor "getMinutesDuration" gives direct access to the valuepublic boolean hasMinutesDurationElement()
public boolean hasMinutesDuration()
public Appointment setMinutesDurationElement(PositiveIntType value)
value - minutesDuration (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).). This is the underlying object with id, value and extensions. The accessor "getMinutesDuration" gives direct access to the valuepublic int getMinutesDuration()
public Appointment setMinutesDuration(int value)
value - 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<Reference> getSlot()
slot (The slots from the participants' schedules that will be filled by the appointment.)public Appointment setSlot(List<Reference> theSlot)
this for easy method chainingpublic boolean hasSlot()
public Appointment addSlot(Reference t)
public Reference getSlotFirstRep()
slot, creating it if it does not already exist@Deprecated public List<Slot> getSlotTarget()
@Deprecated public Slot addSlotTarget()
public DateTimeType getCreatedElement()
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 valuepublic boolean hasCreatedElement()
public boolean hasCreated()
public Appointment setCreatedElement(DateTimeType value)
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 valuepublic Date getCreated()
public Appointment setCreated(Date value)
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.public StringType getCommentElement()
comment (Additional comments about the appointment.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the valuepublic boolean hasCommentElement()
public boolean hasComment()
public Appointment setCommentElement(StringType value)
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 valuepublic String getComment()
public Appointment setComment(String value)
value - Additional comments about the appointment.public List<Reference> getIncomingReferral()
incomingReferral (The referral request this appointment is allocated to assess (incoming referral).)public Appointment setIncomingReferral(List<Reference> theIncomingReferral)
this for easy method chainingpublic boolean hasIncomingReferral()
public Reference addIncomingReferral()
public Appointment addIncomingReferral(Reference t)
public Reference getIncomingReferralFirstRep()
incomingReferral, creating it if it does not already exist@Deprecated public List<ReferralRequest> getIncomingReferralTarget()
@Deprecated public ReferralRequest addIncomingReferralTarget()
public List<Appointment.AppointmentParticipantComponent> getParticipant()
participant (List of participants involved in the appointment.)public Appointment setParticipant(List<Appointment.AppointmentParticipantComponent> theParticipant)
this for easy method chainingpublic boolean hasParticipant()
public Appointment.AppointmentParticipantComponent addParticipant()
public Appointment addParticipant(Appointment.AppointmentParticipantComponent t)
public Appointment.AppointmentParticipantComponent getParticipantFirstRep()
participant, creating it if it does not already existpublic List<Period> getRequestedPeriod()
requestedPeriod (A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.)public Appointment setRequestedPeriod(List<Period> theRequestedPeriod)
this for easy method chainingpublic boolean hasRequestedPeriod()
public Period addRequestedPeriod()
public Appointment addRequestedPeriod(Period t)
public Period getRequestedPeriodFirstRep()
requestedPeriod, creating it if it does not already existprotected void listChildren(List<Property> childrenList)
listChildren in class DomainResourcepublic Base[] getProperty(int hash, String name, boolean checkValid) throws FHIRException
getProperty in class DomainResourceFHIRExceptionpublic Base setProperty(int hash, String name, Base value) throws FHIRException
setProperty in class DomainResourceFHIRExceptionpublic Base setProperty(String name, Base value) throws FHIRException
setProperty in class DomainResourceFHIRExceptionpublic Base makeProperty(int hash, String name) throws FHIRException
makeProperty in class DomainResourceFHIRExceptionpublic String[] getTypesForProperty(int hash, String name) throws FHIRException
getTypesForProperty in class DomainResourceFHIRExceptionpublic Base addChild(String name) throws FHIRException
addChild in class DomainResourceFHIRExceptionpublic String fhirType()
fhirType in class DomainResourcepublic Appointment copy()
copy in class DomainResourceprotected Appointment typedCopy()
public boolean equalsDeep(Base other)
equalsDeep in class DomainResourcepublic boolean equalsShallow(Base other)
equalsShallow in class DomainResourcepublic boolean isEmpty()
isEmpty in interface IBaseisEmpty in class DomainResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2017 University Health Network. All rights reserved.