Skip to main content

HS.FHIR.vSTU3.Model.Resource.AppointmentResponse

deprecated class HS.FHIR.vSTU3.Model.Resource.AppointmentResponse extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = AppointmentResponse;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property actor as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "actor", XMLPROJECTION = "ELEMENT");
A Person, Location/HealthcareService or Device that is participating in the appointment.
Property methods: actorGet(), actorGetSwizzled(), actorIsValid(), actorNewObject(), actorSet()
property appointment as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "appointment", XMLPROJECTION = "ELEMENT") [ Required ];
Appointment that this response is replying to.
Property methods: appointmentGet(), appointmentGetSwizzled(), appointmentIsValid(), appointmentNewObject(), appointmentSet()
property comment as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "comment", XMLPROJECTION = "ELEMENT");
Additional comments about the appointment.
Property methods: commentGet(), commentGetSwizzled(), commentIsValid(), commentNewObject(), commentSet()
property end as HS.FHIR.vSTU3.Model.Datatype.Instant (XMLNAME = "end", XMLPROJECTION = "ELEMENT");
This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
Property methods: endGet(), endGetSwizzled(), endIsValid(), endNewObject(), endSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
This records identifiers associated with this appointment response 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.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property participantStatus as HS.FHIR.vSTU3.Model.Base.ParticipationStatus (XMLNAME = "participantStatus", XMLPROJECTION = "ELEMENT") [ Required ];
Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
Property methods: participantStatusGet(), participantStatusGetSwizzled(), participantStatusIsValid(), participantStatusNewObject(), participantStatusSet()
property participantType as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "participantType", XMLPROJECTION = "ELEMENT");
Role of participant in the appointment.
Property methods: participantTypeBuildValueArray(), participantTypeCollectionToDisplay(), participantTypeCollectionToOdbc(), participantTypeDisplayToCollection(), participantTypeGet(), participantTypeGetObject(), participantTypeGetObjectId(), participantTypeGetSwizzled(), participantTypeIsValid(), participantTypeOdbcToCollection(), participantTypeSet(), participantTypeSetObject(), participantTypeSetObjectId()
property start as HS.FHIR.vSTU3.Model.Datatype.Instant (XMLNAME = "start", XMLPROJECTION = "ELEMENT");
Date/Time that the appointment is to take place, or requested new start time.
Property methods: startGet(), startGetSwizzled(), startIsValid(), startNewObject(), startSet()

Methods

deprecated method SetActor(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "actor" property.
deprecated method SetAppointment(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "appointment" property.
deprecated method SetComment(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "comment" property.
deprecated method SetEnd(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "end" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetParticipantStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "participantStatus" property.
deprecated method SetParticipantType(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "participantType" property.
deprecated method SetStart(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "start" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab