Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

Thanks for your feedback!
Need to tell us more? Click here or use the Feedback button.

Is this page helpful?

Class Details

Parameters (5)
Properties (8)
Inherited Members

Show private members

HS.FHIR.DTL.vSTU3.Model.Resource.Schedule

class HS.FHIR.DTL.vSTU3.Model.Resource.Schedule extends HS.FHIR.DTL.vSTU3.Model.Base.DomainResource

A container for slots of time that may be available for booking appointments.

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 = Schedule;

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 XMLPROJECTION = ELEMENT;

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 = Schedule;

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 active as %Boolean (XMLNAME = "active", XMLPROJECTION = "ATTRIBUTE");

boolean

Whether this schedule is in active use.

Property methods: activeDisplayToLogical(), activeGet(), activeIsValid(), activeLogicalToDisplay(), activeLogicalToXSD(), activeNormalize(), activeSet(), activeXSDToLogical()

property actor as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "actor", XMLPROJECTION = "ELEMENT") [ Required ];

Reference

The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson.

Property methods: actorBuildValueArray(), actorCollectionToDisplay(), actorCollectionToOdbc(), actorDisplayToCollection(), actorGet(), actorGetObject(), actorGetObjectId(), actorGetSwizzled(), actorIsValid(), actorOdbcToCollection(), actorSet(), actorSetObject(), actorSetObjectId()

property comment as %String (MAXLEN = 1000000, XMLNAME = "comment", XMLPROJECTION = "ATTRIBUTE");

string

Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

Property methods: commentDisplayToLogical(), commentGet(), commentIsValid(), commentLogicalToDisplay(), commentLogicalToOdbc(), commentNormalize(), commentSet()

property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Identifier

External Ids for this item.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()

property planningHorizon as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "planningHorizon", XMLPROJECTION = "ELEMENT");

Period

The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a

Property methods: planningHorizonGet(), planningHorizonGetSwizzled(), planningHorizonIsValid(), planningHorizonNewObject(), planningHorizonSet()

property serviceCategory as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "serviceCategory", XMLPROJECTION = "ELEMENT");

CodeableConcept

A broad categorisation of the service that is to be performed during this appointment.

any FHIR3 code may be used; service-category shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: serviceCategoryGet(), serviceCategoryGetSwizzled(), serviceCategoryIsValid(), serviceCategoryNewObject(), serviceCategorySet()

property serviceType as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "serviceType", XMLPROJECTION = "ELEMENT");

CodeableConcept

The specific service that is to be performed during this appointment.

any FHIR3 code may be used; service-type shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: serviceTypeBuildValueArray(), serviceTypeCollectionToDisplay(), serviceTypeCollectionToOdbc(), serviceTypeDisplayToCollection(), serviceTypeGet(), serviceTypeGetObject(), serviceTypeGetObjectId(), serviceTypeGetSwizzled(), serviceTypeIsValid(), serviceTypeOdbcToCollection(), serviceTypeSet(), serviceTypeSetObject(), serviceTypeSetObjectId()

property specialty as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "specialty", XMLPROJECTION = "ELEMENT");

CodeableConcept

The specialty of a practitioner that would be required to perform the service requested in this appointment.

c80-practice-codes is the PREFERRED FHIR3 ValueSet for codes, but if you need to express meanings not found in c80-practice-codes, you may use codes from any ValueSet.

Property methods: specialtyBuildValueArray(), specialtyCollectionToDisplay(), specialtyCollectionToOdbc(), specialtyDisplayToCollection(), specialtyGet(), specialtyGetObject(), specialtyGetObjectId(), specialtyGetSwizzled(), specialtyIsValid(), specialtyOdbcToCollection(), specialtySet(), specialtySetObject(), specialtySetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

Feedback