Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.AppointmentResponse extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

Property Inventory


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.
parameter XMLTYPE = AppointmentResponse;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property actor as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "actor", XMLPROJECTION = "ELEMENT");

Person, Location, HealthcareService, or Device.

Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location

Property methods: actorGet(), actorGetSwizzled(), actorIsValid(), actorNewObject(), actorSet()
property appointment as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "appointment", XMLPROJECTION = "ELEMENT") [ Required ];

Appointment this response relates to.


Property methods: appointmentGet(), appointmentGetSwizzled(), appointmentIsValid(), appointmentNewObject(), appointmentSet()
property comment as %String (MAXLEN = 1000000, XMLNAME = "comment", XMLPROJECTION = "ATTRIBUTE");

Additional comments.

Property methods: commentDisplayToLogical(), commentGet(), commentIsValid(), commentLogicalToDisplay(), commentLogicalToOdbc(), commentNormalize(), commentSet()
property end as %String (MAXLEN = 1000000, XMLNAME = "end", XMLPROJECTION = "ATTRIBUTE");

Time from appointment, or requested new end time.

Property methods: endDisplayToLogical(), endGet(), endIsValid(), endLogicalToDisplay(), endLogicalToOdbc(), endNormalize(), endSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

External Ids for this item.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property participantStatus as %String (MAXLEN = 1000000, XMLNAME = "participantStatus", XMLPROJECTION = "ATTRIBUTE") [ Required ];

accepted | declined | tentative | needs-action

participationstatus|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend participationstatus|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: participantStatusDisplayToLogical(), participantStatusGet(), participantStatusIsValid(), participantStatusLogicalToDisplay(), participantStatusLogicalToOdbc(), participantStatusNormalize(), participantStatusSet()
property participantType as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "participantType", XMLPROJECTION = "ELEMENT");

Role of participant in the appointment.

encounter-participant-type is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in encounter-participant-type, you may formally EXTEND encounter-participant-type to add codes to it.

Property methods: participantTypeBuildValueArray(), participantTypeCollectionToDisplay(), participantTypeCollectionToOdbc(), participantTypeDisplayToCollection(), participantTypeGet(), participantTypeGetObject(), participantTypeGetObjectId(), participantTypeGetSwizzled(), participantTypeIsValid(), participantTypeOdbcToCollection(), participantTypeSet(), participantTypeSetObject(), participantTypeSetObjectId()
property start as %String (MAXLEN = 1000000, XMLNAME = "start", XMLPROJECTION = "ATTRIBUTE");

Time from appointment, or requested new start time.

Property methods: startDisplayToLogical(), startGet(), startIsValid(), startLogicalToDisplay(), startLogicalToOdbc(), startNormalize(), startSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab