Skip to main content

HS.FHIRModel.R4.AppointmentResponse

class HS.FHIRModel.R4.AppointmentResponse extends HS.FHIRModel.FHIRClassSuper

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

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_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.

Properties

property _comment as HS.FHIRModel.R4.Element;
Extensions for comment
Property methods: _commentGet(), _commentGetSwizzled(), _commentIsValid(), _commentNewObject(), _commentSet()
property _end as HS.FHIRModel.R4.Element;
Extensions for end
Property methods: _endGet(), _endGetSwizzled(), _endIsValid(), _endNewObject(), _endSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _participantStatus as HS.FHIRModel.R4.Element;
Extensions for participantStatus
Property methods: _participantStatusGet(), _participantStatusGetSwizzled(), _participantStatusIsValid(), _participantStatusNewObject(), _participantStatusSet()
property _start as HS.FHIRModel.R4.Element;
Extensions for start
Property methods: _startGet(), _startGetSwizzled(), _startIsValid(), _startNewObject(), _startSet()
property actor as HS.FHIRModel.R4.Reference;
A Person, Location, HealthcareService, or Device that is participating in the appointment.
Property methods: actorGet(), actorGetSwizzled(), actorIsValid(), actorNewObject(), actorSet()
property appointment as HS.FHIRModel.R4.Reference [ Required ];
Appointment that this response is replying to.
Property methods: appointmentGet(), appointmentGetSwizzled(), appointmentIsValid(), appointmentNewObject(), appointmentSet()
property comment as %String;
Additional comments about the appointment.
Property methods: commentDisplayToLogical(), commentGet(), commentIsValid(), commentLogicalToDisplay(), commentLogicalToOdbc(), commentNormalize(), commentSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property end as %String;
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: endDisplayToLogical(), endGet(), endIsValid(), endLogicalToDisplay(), endLogicalToOdbc(), endNormalize(), endSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
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: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property participantStatus as %String;
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: participantStatusDisplayToLogical(), participantStatusGet(), participantStatusIsValid(), participantStatusLogicalToDisplay(), participantStatusLogicalToOdbc(), participantStatusNormalize(), participantStatusSet()
property participantType as HS.FHIRModel.R4.SeqOfCodeableConcept;
Role of participant in the appointment.
Property methods: participantTypeGet(), participantTypeGetSwizzled(), participantTypeIsValid(), participantTypeNewObject(), participantTypeSet()
property resourceType as %String [ InitialExpression = "AppointmentResponse" , Required ];
This is a AppointmentResponse resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property start as %String;
Date/Time that the appointment is to take place, or requested new start time.
Property methods: startDisplayToLogical(), startGet(), startIsValid(), startLogicalToDisplay(), startLogicalToOdbc(), startNormalize(), startSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeActor()
method IncludeAppointment()
method IncludeContained()
method IncludeExtension()
method IncludeIdentifier()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeParticipantType()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab