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 (24)
Inherited Members

Show private members

HS.FHIR.DTL.vR4.Model.Resource.HealthcareService

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

The details of a healthcare service available at a location.

Property 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 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 = HealthcareService;

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 HealthcareService record is in active use.

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

property appointmentRequired as %Boolean (XMLNAME = "appointmentRequired", XMLPROJECTION = "ATTRIBUTE");

boolean

If an appointment is required for access to this service.

Property methods: appointmentRequiredDisplayToLogical(), appointmentRequiredGet(), appointmentRequiredIsValid(), appointmentRequiredLogicalToDisplay(), appointmentRequiredLogicalToXSD(), appointmentRequiredNormalize(), appointmentRequiredSet(), appointmentRequiredXSDToLogical()

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

string

Description of availability exceptions.

Property methods: availabilityExceptionsDisplayToLogical(), availabilityExceptionsGet(), availabilityExceptionsIsValid(), availabilityExceptionsLogicalToDisplay(), availabilityExceptionsLogicalToOdbc(), availabilityExceptionsNormalize(), availabilityExceptionsSet()

property availableTime as list of HS.FHIR.DTL.vR4.Model.Element.HealthcareService.availableTime (XMLNAME = "availableTime", XMLPROJECTION = "ELEMENT");

BackboneElement

Times the Service Site is available.

Property methods: availableTimeBuildValueArray(), availableTimeCollectionToDisplay(), availableTimeCollectionToOdbc(), availableTimeDisplayToCollection(), availableTimeGet(), availableTimeGetObject(), availableTimeGetObjectId(), availableTimeGetSwizzled(), availableTimeIsValid(), availableTimeOdbcToCollection(), availableTimeSet(), availableTimeSetObject(), availableTimeSetObjectId()

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

CodeableConcept

Broad category of service being performed or delivered.

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

Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()

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

CodeableConcept

Collection of characteristics (attributes)

any FHIR4 code from any ValueSet may be used.

Property methods: characteristicBuildValueArray(), characteristicCollectionToDisplay(), characteristicCollectionToOdbc(), characteristicDisplayToCollection(), characteristicGet(), characteristicGetObject(), characteristicGetObjectId(), characteristicGetSwizzled(), characteristicIsValid(), characteristicOdbcToCollection(), characteristicSet(), characteristicSetObject(), characteristicSetObjectId()

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

string

Additional description and/or any specific issues not covered elsewhere.

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

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

CodeableConcept

The language that this service is offered in.

languages is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in languages, you may use codes from any ValueSet.

Property methods: communicationBuildValueArray(), communicationCollectionToDisplay(), communicationCollectionToOdbc(), communicationDisplayToCollection(), communicationGet(), communicationGetObject(), communicationGetObjectId(), communicationGetSwizzled(), communicationIsValid(), communicationOdbcToCollection(), communicationSet(), communicationSetObject(), communicationSetObjectId()

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

Reference

Location(s) service is intended for/available to.

Location

Property methods: coverageAreaBuildValueArray(), coverageAreaCollectionToDisplay(), coverageAreaCollectionToOdbc(), coverageAreaDisplayToCollection(), coverageAreaGet(), coverageAreaGetObject(), coverageAreaGetObjectId(), coverageAreaGetSwizzled(), coverageAreaIsValid(), coverageAreaOdbcToCollection(), coverageAreaSet(), coverageAreaSetObject(), coverageAreaSetObjectId()

property eligibility as list of HS.FHIR.DTL.vR4.Model.Element.HealthcareService.eligibility (XMLNAME = "eligibility", XMLPROJECTION = "ELEMENT");

BackboneElement

Specific eligibility requirements required to use the service.

Property methods: eligibilityBuildValueArray(), eligibilityCollectionToDisplay(), eligibilityCollectionToOdbc(), eligibilityDisplayToCollection(), eligibilityGet(), eligibilityGetObject(), eligibilityGetObjectId(), eligibilityGetSwizzled(), eligibilityIsValid(), eligibilityOdbcToCollection(), eligibilitySet(), eligibilitySetObject(), eligibilitySetObjectId()

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

Reference

Technical endpoints providing access to electronic services operated for the healthcare service.

Endpoint

Property methods: endpointBuildValueArray(), endpointCollectionToDisplay(), endpointCollectionToOdbc(), endpointDisplayToCollection(), endpointGet(), endpointGetObject(), endpointGetObjectId(), endpointGetSwizzled(), endpointIsValid(), endpointOdbcToCollection(), endpointSet(), endpointSetObject(), endpointSetObjectId()

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

markdown

Extra details about the service that can't be placed in the other fields.

Property methods: extraDetailsDisplayToLogical(), extraDetailsGet(), extraDetailsIsValid(), extraDetailsLogicalToDisplay(), extraDetailsLogicalToOdbc(), extraDetailsNormalize(), extraDetailsSet()

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

Identifier

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.DTL.vR4.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");

Reference

Location(s) where service may be provided.

Location

Property methods: locationBuildValueArray(), locationCollectionToDisplay(), locationCollectionToOdbc(), locationDisplayToCollection(), locationGet(), locationGetObject(), locationGetObjectId(), locationGetSwizzled(), locationIsValid(), locationOdbcToCollection(), locationSet(), locationSetObject(), locationSetObjectId()

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

string

Description of service as presented to a consumer while searching.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()

property notAvailable as list of HS.FHIR.DTL.vR4.Model.Element.HealthcareService.notAvailable (XMLNAME = "notAvailable", XMLPROJECTION = "ELEMENT");

BackboneElement

Not available during this time due to provided reason.

Property methods: notAvailableBuildValueArray(), notAvailableCollectionToDisplay(), notAvailableCollectionToOdbc(), notAvailableDisplayToCollection(), notAvailableGet(), notAvailableGetObject(), notAvailableGetObjectId(), notAvailableGetSwizzled(), notAvailableIsValid(), notAvailableOdbcToCollection(), notAvailableSet(), notAvailableSetObject(), notAvailableSetObjectId()

property photo as HS.FHIR.DTL.vR4.Model.Datatype.Attachment (XMLNAME = "photo", XMLPROJECTION = "ELEMENT");

Attachment

Facilitates quick identification of the service.

Property methods: photoGet(), photoGetSwizzled(), photoIsValid(), photoNewObject(), photoSet()

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

CodeableConcept

Programs that this service is applicable to.

any FHIR4 code may be used; program shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: programBuildValueArray(), programCollectionToDisplay(), programCollectionToOdbc(), programDisplayToCollection(), programGet(), programGetObject(), programGetObjectId(), programGetSwizzled(), programIsValid(), programOdbcToCollection(), programSet(), programSetObject(), programSetObjectId()

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

Reference

Organization that provides this service.

Organization

Property methods: providedByGet(), providedByGetSwizzled(), providedByIsValid(), providedByNewObject(), providedBySet()

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

CodeableConcept

Ways that the service accepts referrals.

any FHIR4 code may be used; service-referral-method shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: referralMethodBuildValueArray(), referralMethodCollectionToDisplay(), referralMethodCollectionToOdbc(), referralMethodDisplayToCollection(), referralMethodGet(), referralMethodGetObject(), referralMethodGetObjectId(), referralMethodGetSwizzled(), referralMethodIsValid(), referralMethodOdbcToCollection(), referralMethodSet(), referralMethodSetObject(), referralMethodSetObjectId()

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

CodeableConcept

Conditions under which service is available/offered.

any FHIR4 code may be used; service-provision-conditions shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: serviceProvisionCodeBuildValueArray(), serviceProvisionCodeCollectionToDisplay(), serviceProvisionCodeCollectionToOdbc(), serviceProvisionCodeDisplayToCollection(), serviceProvisionCodeGet(), serviceProvisionCodeGetObject(), serviceProvisionCodeGetObjectId(), serviceProvisionCodeGetSwizzled(), serviceProvisionCodeIsValid(), serviceProvisionCodeOdbcToCollection(), serviceProvisionCodeSet(), serviceProvisionCodeSetObject(), serviceProvisionCodeSetObjectId()

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

CodeableConcept

Specialties handled by the HealthcareService.

c80-practice-codes is the PREFERRED FHIR4 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()

property telecom as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactPoint (XMLNAME = "telecom", XMLPROJECTION = "ELEMENT");

ContactPoint

Contacts related to the healthcare service.

Property methods: telecomBuildValueArray(), telecomCollectionToDisplay(), telecomCollectionToOdbc(), telecomDisplayToCollection(), telecomGet(), telecomGetObject(), telecomGetObjectId(), telecomGetSwizzled(), telecomIsValid(), telecomOdbcToCollection(), telecomSet(), telecomSetObject(), telecomSetObjectId()

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

CodeableConcept

Type of service that may be delivered or performed.

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

Property methods: typeBuildValueArray(), typeCollectionToDisplay(), typeCollectionToOdbc(), typeDisplayToCollection(), typeGet(), typeGetObject(), typeGetObjectId(), typeGetSwizzled(), typeIsValid(), typeOdbcToCollection(), typeSet(), typeSetObject(), typeSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

Feedback