Skip to main content

HS.FHIR.vSTU3.Model.Resource.HealthcareService

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
The details of a healthcare service available at a location.
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 = HealthcareService;
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 active as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "active", XMLPROJECTION = "ELEMENT");
Whether this healthcareservice record is in active use.
Property methods: activeGet(), activeGetSwizzled(), activeIsValid(), activeNewObject(), activeSet()
property appointmentRequired as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "appointmentRequired", XMLPROJECTION = "ELEMENT");
Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.
Property methods: appointmentRequiredGet(), appointmentRequiredGetSwizzled(), appointmentRequiredIsValid(), appointmentRequiredNewObject(), appointmentRequiredSet()
property availabilityExceptions as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "availabilityExceptions", XMLPROJECTION = "ELEMENT");
A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
Property methods: availabilityExceptionsGet(), availabilityExceptionsGetSwizzled(), availabilityExceptionsIsValid(), availabilityExceptionsNewObject(), availabilityExceptionsSet()
property availableTime as list of HS.FHIR.vSTU3.Model.Resource.HealthcareService.AvailableTime (XMLNAME = "availableTime", XMLPROJECTION = "ELEMENT");
A collection of times that the Service Site is available.
Property methods: availableTimeBuildValueArray(), availableTimeCollectionToDisplay(), availableTimeCollectionToOdbc(), availableTimeDisplayToCollection(), availableTimeGet(), availableTimeGetObject(), availableTimeGetObjectId(), availableTimeGetSwizzled(), availableTimeIsValid(), availableTimeOdbcToCollection(), availableTimeSet(), availableTimeSetObject(), availableTimeSetObjectId()
property category as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
Identifies the broad category of service being performed or delivered.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property characteristic as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "characteristic", XMLPROJECTION = "ELEMENT");
Collection of characteristics (attributes).
Property methods: characteristicBuildValueArray(), characteristicCollectionToDisplay(), characteristicCollectionToOdbc(), characteristicDisplayToCollection(), characteristicGet(), characteristicGetObject(), characteristicGetObjectId(), characteristicGetSwizzled(), characteristicIsValid(), characteristicOdbcToCollection(), characteristicSet(), characteristicSetObject(), characteristicSetObjectId()
property comment as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "comment", XMLPROJECTION = "ELEMENT");
Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.
Property methods: commentGet(), commentGetSwizzled(), commentIsValid(), commentNewObject(), commentSet()
property coverageArea as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "coverageArea", XMLPROJECTION = "ELEMENT");
The location(s) that this service is available to (not where the service is provided).
Property methods: coverageAreaBuildValueArray(), coverageAreaCollectionToDisplay(), coverageAreaCollectionToOdbc(), coverageAreaDisplayToCollection(), coverageAreaGet(), coverageAreaGetObject(), coverageAreaGetObjectId(), coverageAreaGetSwizzled(), coverageAreaIsValid(), coverageAreaOdbcToCollection(), coverageAreaSet(), coverageAreaSetObject(), coverageAreaSetObjectId()
property eligibility as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "eligibility", XMLPROJECTION = "ELEMENT");
Does this service have specific eligibility requirements that need to be met in order to use the service?
Property methods: eligibilityGet(), eligibilityGetSwizzled(), eligibilityIsValid(), eligibilityNewObject(), eligibilityNoteGet(), eligibilityNoteGetSwizzled(), eligibilityNoteIsValid(), eligibilityNoteNewObject(), eligibilityNoteSet(), eligibilitySet()
property eligibilityNote as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "eligibilityNote", XMLPROJECTION = "ELEMENT");
Describes the eligibility conditions for the service.
Property methods: eligibilityNoteGet(), eligibilityNoteGetSwizzled(), eligibilityNoteIsValid(), eligibilityNoteNewObject(), eligibilityNoteSet()
property endpoint as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "endpoint", XMLPROJECTION = "ELEMENT");
Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
Property methods: endpointBuildValueArray(), endpointCollectionToDisplay(), endpointCollectionToOdbc(), endpointDisplayToCollection(), endpointGet(), endpointGetObject(), endpointGetObjectId(), endpointGetSwizzled(), endpointIsValid(), endpointOdbcToCollection(), endpointSet(), endpointSetObject(), endpointSetObjectId()
property extraDetails as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "extraDetails", XMLPROJECTION = "ELEMENT");
Extra details about the service that can't be placed in the other fields.
Property methods: extraDetailsGet(), extraDetailsGetSwizzled(), extraDetailsIsValid(), extraDetailsNewObject(), extraDetailsSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
External identifiers for this item.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property location as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
The location(s) where this healthcare service may be provided.
Property methods: locationBuildValueArray(), locationCollectionToDisplay(), locationCollectionToOdbc(), locationDisplayToCollection(), locationGet(), locationGetObject(), locationGetObjectId(), locationGetSwizzled(), locationIsValid(), locationOdbcToCollection(), locationSet(), locationSetObject(), locationSetObjectId()
property name as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT");
Further description of the service as it would be presented to a consumer while searching.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property notAvailable as list of HS.FHIR.vSTU3.Model.Resource.HealthcareService.NotAvailable (XMLNAME = "notAvailable", XMLPROJECTION = "ELEMENT");
The HealthcareService is not available during this period of time due to the provided reason.
Property methods: notAvailableBuildValueArray(), notAvailableCollectionToDisplay(), notAvailableCollectionToOdbc(), notAvailableDisplayToCollection(), notAvailableGet(), notAvailableGetObject(), notAvailableGetObjectId(), notAvailableGetSwizzled(), notAvailableIsValid(), notAvailableOdbcToCollection(), notAvailableSet(), notAvailableSetObject(), notAvailableSetObjectId()
property photo as HS.FHIR.vSTU3.Model.Base.Attachment (XMLNAME = "photo", XMLPROJECTION = "ELEMENT");
If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
Property methods: photoGet(), photoGetSwizzled(), photoIsValid(), photoNewObject(), photoSet()
property programName as list of HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "programName", XMLPROJECTION = "ELEMENT");
Program Names that can be used to categorize the service.
Property methods: programNameBuildValueArray(), programNameCollectionToDisplay(), programNameCollectionToOdbc(), programNameDisplayToCollection(), programNameGet(), programNameGetObject(), programNameGetObjectId(), programNameGetSwizzled(), programNameIsValid(), programNameOdbcToCollection(), programNameSet(), programNameSetObject(), programNameSetObjectId()
property providedBy as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "providedBy", XMLPROJECTION = "ELEMENT");
The organization that provides this healthcare service.
Property methods: providedByGet(), providedByGetSwizzled(), providedByIsValid(), providedByNewObject(), providedBySet()
property referralMethod as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "referralMethod", XMLPROJECTION = "ELEMENT");
Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
Property methods: referralMethodBuildValueArray(), referralMethodCollectionToDisplay(), referralMethodCollectionToOdbc(), referralMethodDisplayToCollection(), referralMethodGet(), referralMethodGetObject(), referralMethodGetObjectId(), referralMethodGetSwizzled(), referralMethodIsValid(), referralMethodOdbcToCollection(), referralMethodSet(), referralMethodSetObject(), referralMethodSetObjectId()
property serviceProvisionCode as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "serviceProvisionCode", XMLPROJECTION = "ELEMENT");
The code(s) that detail the conditions under which the healthcare service is available/offered.
Property methods: serviceProvisionCodeBuildValueArray(), serviceProvisionCodeCollectionToDisplay(), serviceProvisionCodeCollectionToOdbc(), serviceProvisionCodeDisplayToCollection(), serviceProvisionCodeGet(), serviceProvisionCodeGetObject(), serviceProvisionCodeGetObjectId(), serviceProvisionCodeGetSwizzled(), serviceProvisionCodeIsValid(), serviceProvisionCodeOdbcToCollection(), serviceProvisionCodeSet(), serviceProvisionCodeSetObject(), serviceProvisionCodeSetObjectId()
property specialty as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "specialty", XMLPROJECTION = "ELEMENT");
Collection of specialties handled by the service site. This is more of a medical term.
Property methods: specialtyBuildValueArray(), specialtyCollectionToDisplay(), specialtyCollectionToOdbc(), specialtyDisplayToCollection(), specialtyGet(), specialtyGetObject(), specialtyGetObjectId(), specialtyGetSwizzled(), specialtyIsValid(), specialtyOdbcToCollection(), specialtySet(), specialtySetObject(), specialtySetObjectId()
property telecom as list of HS.FHIR.vSTU3.Model.Base.ContactPoint (XMLNAME = "telecom", XMLPROJECTION = "ELEMENT");
List of contacts related to this specific healthcare service.
Property methods: telecomBuildValueArray(), telecomCollectionToDisplay(), telecomCollectionToOdbc(), telecomDisplayToCollection(), telecomGet(), telecomGetObject(), telecomGetObjectId(), telecomGetSwizzled(), telecomIsValid(), telecomOdbcToCollection(), telecomSet(), telecomSetObject(), telecomSetObjectId()
property type as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
The specific type of service that may be delivered or performed.
Property methods: typeBuildValueArray(), typeCollectionToDisplay(), typeCollectionToOdbc(), typeDisplayToCollection(), typeGet(), typeGetObject(), typeGetObjectId(), typeGetSwizzled(), typeIsValid(), typeOdbcToCollection(), typeSet(), typeSetObject(), typeSetObjectId()

Methods

deprecated method SetActive(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 "active" property.
deprecated method SetAppointmentRequired(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 "appointmentRequired" property.
deprecated method SetAvailabilityExceptions(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 "availabilityExceptions" property.
deprecated method SetCategory(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.
Set method for the "category" property.
deprecated method SetCharacteristic(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 "characteristic" 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 SetCoverageArea(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "coverageArea" property.
deprecated method SetEligibility(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.
Set method for the "eligibility" property.
deprecated method SetEligibilityNote(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 "eligibilityNote" property.
deprecated method SetEndpoint(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "endpoint" property.
deprecated method SetExtraDetails(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 "extraDetails" 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 SetLocation(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "location" property.
deprecated method SetName(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 "name" property.
deprecated method SetPhoto(pContentType As %String = "", pLanguage As %String = "", pData As %String = "", pUrl As %String = "", pSize As %String = "", pHash As %String = "", pTitle As %String = "", pCreation As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "photo" property.
deprecated method SetProgramName(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "programName" property.
deprecated method SetProvidedBy(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 "providedBy" property.
deprecated method SetReferralMethod(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 "referralMethod" property.
deprecated method SetServiceProvisionCode(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 "serviceProvisionCode" property.
deprecated method SetSpecialty(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 "specialty" property.
deprecated method SetTelecom(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pRank As %String = "", pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "telecom" property.
deprecated method SetType(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 "type" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab