Package org.hl7.fhir.dstu3.model

Class HealthcareService

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.model.HealthcareService

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class HealthcareService
extends DomainResource

The details of a healthcare service available at a location.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HealthcareService.DaysOfWeek
static class	HealthcareService.DaysOfWeekEnumFactory
static class	HealthcareService.HealthcareServiceAvailableTimeComponent
static class	HealthcareService.HealthcareServiceNotAvailableComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanType	active	Whether this healthcareservice record is in active use.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	ACTIVE	Fluent Client search parameter constant for active
protected BooleanType	appointmentRequired	Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization.
protected StringType	availabilityExceptions	A description of site availability exceptions, e.g.
protected List<HealthcareService.HealthcareServiceAvailableTimeComponent>	availableTime	A collection of times that the Service Site is available.
protected CodeableConcept	category	Identifies the broad category of service being performed or delivered.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CATEGORY	Fluent Client search parameter constant for category
protected List<CodeableConcept>	characteristic	Collection of characteristics (attributes).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CHARACTERISTIC	Fluent Client search parameter constant for characteristic
protected StringType	comment	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.
protected List<Reference>	coverageArea	The location(s) that this service is available to (not where the service is provided).
protected List<Location>	coverageAreaTarget	The actual objects that are the target of the reference (The location(s) that this service is available to (not where the service is provided).)
protected CodeableConcept	eligibility	Does this service have specific eligibility requirements that need to be met in order to use the service?
protected StringType	eligibilityNote	Describes the eligibility conditions for the service.
protected List<Reference>	endpoint	Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENDPOINT	Fluent Client search parameter constant for endpoint
protected List<Endpoint>	endpointTarget	The actual objects that are the target of the reference (Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.)
protected StringType	extraDetails	Extra details about the service that can't be placed in the other fields.
protected List<Identifier>	identifier	External identifiers for this item.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENDPOINT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_LOCATION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ORGANIZATION	Constant for fluent queries to be used to add include statements.
protected List<Reference>	location	The location(s) where this healthcare service may be provided.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	LOCATION	Fluent Client search parameter constant for location
protected List<Location>	locationTarget	The actual objects that are the target of the reference (The location(s) where this healthcare service may be provided.)
protected StringType	name	Further description of the service as it would be presented to a consumer while searching.
static final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
protected List<HealthcareService.HealthcareServiceNotAvailableComponent>	notAvailable	The HealthcareService is not available during this period of time due to the provided reason.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ORGANIZATION	Fluent Client search parameter constant for organization
protected Attachment	photo	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.
protected List<StringType>	programName	Program Names that can be used to categorize the service.
static final ca.uhn.fhir.rest.gclient.StringClientParam	PROGRAMNAME	Fluent Client search parameter constant for programname
protected Reference	providedBy	The organization that provides this healthcare service.
protected Organization	providedByTarget	The actual object that is the target of the reference (The organization that provides this healthcare service.)
protected List<CodeableConcept>	referralMethod	Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
protected List<CodeableConcept>	serviceProvisionCode	The code(s) that detail the conditions under which the healthcare service is available/offered.
static final String	SP_ACTIVE	Search parameter: active
static final String	SP_CATEGORY	Search parameter: category
static final String	SP_CHARACTERISTIC	Search parameter: characteristic
static final String	SP_ENDPOINT	Search parameter: endpoint
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_LOCATION	Search parameter: location
static final String	SP_NAME	Search parameter: name
static final String	SP_ORGANIZATION	Search parameter: organization
static final String	SP_PROGRAMNAME	Search parameter: programname
static final String	SP_TYPE	Search parameter: type
protected List<CodeableConcept>	specialty	Collection of specialties handled by the service site.
protected List<ContactPoint>	telecom	List of contacts related to this specific healthcare service.
protected List<CodeableConcept>	type	The specific type of service that may be delivered or performed.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
HealthcareService()	Constructor

Method Summary

Modifier and Type	Method	Description
HealthcareService.HealthcareServiceAvailableTimeComponent	addAvailableTime()
HealthcareService	addAvailableTime(HealthcareService.HealthcareServiceAvailableTimeComponent t)
CodeableConcept	addCharacteristic()
HealthcareService	addCharacteristic(CodeableConcept t)
Base	addChild(String name)
Reference	addCoverageArea()
HealthcareService	addCoverageArea(Reference t)
Location	addCoverageAreaTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Reference	addEndpoint()
HealthcareService	addEndpoint(Reference t)
Endpoint	addEndpointTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Identifier	addIdentifier()
HealthcareService	addIdentifier(Identifier t)
Reference	addLocation()
HealthcareService	addLocation(Reference t)
Location	addLocationTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
HealthcareService.HealthcareServiceNotAvailableComponent	addNotAvailable()
HealthcareService	addNotAvailable(HealthcareService.HealthcareServiceNotAvailableComponent t)
HealthcareService	addProgramName(String value)
StringType	addProgramNameElement()
CodeableConcept	addReferralMethod()
HealthcareService	addReferralMethod(CodeableConcept t)
CodeableConcept	addServiceProvisionCode()
HealthcareService	addServiceProvisionCode(CodeableConcept t)
CodeableConcept	addSpecialty()
HealthcareService	addSpecialty(CodeableConcept t)
ContactPoint	addTelecom()
HealthcareService	addTelecom(ContactPoint t)
CodeableConcept	addType()
HealthcareService	addType(CodeableConcept t)
HealthcareService	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getActive()
BooleanType	getActiveElement()
boolean	getAppointmentRequired()
BooleanType	getAppointmentRequiredElement()
String	getAvailabilityExceptions()
StringType	getAvailabilityExceptionsElement()
List<HealthcareService.HealthcareServiceAvailableTimeComponent>	getAvailableTime()
HealthcareService.HealthcareServiceAvailableTimeComponent	getAvailableTimeFirstRep()
CodeableConcept	getCategory()
List<CodeableConcept>	getCharacteristic()
CodeableConcept	getCharacteristicFirstRep()
String	getComment()
StringType	getCommentElement()
List<Reference>	getCoverageArea()
Reference	getCoverageAreaFirstRep()
List<Location>	getCoverageAreaTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
CodeableConcept	getEligibility()
String	getEligibilityNote()
StringType	getEligibilityNoteElement()
List<Reference>	getEndpoint()
Reference	getEndpointFirstRep()
List<Endpoint>	getEndpointTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
String	getExtraDetails()
StringType	getExtraDetailsElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Reference>	getLocation()
Reference	getLocationFirstRep()
List<Location>	getLocationTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
List<HealthcareService.HealthcareServiceNotAvailableComponent>	getNotAvailable()
HealthcareService.HealthcareServiceNotAvailableComponent	getNotAvailableFirstRep()
Attachment	getPhoto()
List<StringType>	getProgramName()
Base[]	getProperty(int hash, String name, boolean checkValid)
Reference	getProvidedBy()
Organization	getProvidedByTarget()
List<CodeableConcept>	getReferralMethod()
CodeableConcept	getReferralMethodFirstRep()
ResourceType	getResourceType()
List<CodeableConcept>	getServiceProvisionCode()
CodeableConcept	getServiceProvisionCodeFirstRep()
List<CodeableConcept>	getSpecialty()
CodeableConcept	getSpecialtyFirstRep()
List<ContactPoint>	getTelecom()
ContactPoint	getTelecomFirstRep()
List<CodeableConcept>	getType()
CodeableConcept	getTypeFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasActive()
boolean	hasActiveElement()
boolean	hasAppointmentRequired()
boolean	hasAppointmentRequiredElement()
boolean	hasAvailabilityExceptions()
boolean	hasAvailabilityExceptionsElement()
boolean	hasAvailableTime()
boolean	hasCategory()
boolean	hasCharacteristic()
boolean	hasComment()
boolean	hasCommentElement()
boolean	hasCoverageArea()
boolean	hasEligibility()
boolean	hasEligibilityNote()
boolean	hasEligibilityNoteElement()
boolean	hasEndpoint()
boolean	hasExtraDetails()
boolean	hasExtraDetailsElement()
boolean	hasIdentifier()
boolean	hasLocation()
boolean	hasName()
boolean	hasNameElement()
boolean	hasNotAvailable()
boolean	hasPhoto()
boolean	hasProgramName()
boolean	hasProgramName(String value)
boolean	hasProvidedBy()
boolean	hasReferralMethod()
boolean	hasServiceProvisionCode()
boolean	hasSpecialty()
boolean	hasTelecom()
boolean	hasType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
HealthcareService	setActive(boolean value)
HealthcareService	setActiveElement(BooleanType value)
HealthcareService	setAppointmentRequired(boolean value)
HealthcareService	setAppointmentRequiredElement(BooleanType value)
HealthcareService	setAvailabilityExceptions(String value)
HealthcareService	setAvailabilityExceptionsElement(StringType value)
HealthcareService	setAvailableTime(List<HealthcareService.HealthcareServiceAvailableTimeComponent> theAvailableTime)
HealthcareService	setCategory(CodeableConcept value)
HealthcareService	setCharacteristic(List<CodeableConcept> theCharacteristic)
HealthcareService	setComment(String value)
HealthcareService	setCommentElement(StringType value)
HealthcareService	setCoverageArea(List<Reference> theCoverageArea)
HealthcareService	setEligibility(CodeableConcept value)
HealthcareService	setEligibilityNote(String value)
HealthcareService	setEligibilityNoteElement(StringType value)
HealthcareService	setEndpoint(List<Reference> theEndpoint)
HealthcareService	setExtraDetails(String value)
HealthcareService	setExtraDetailsElement(StringType value)
HealthcareService	setIdentifier(List<Identifier> theIdentifier)
HealthcareService	setLocation(List<Reference> theLocation)
HealthcareService	setName(String value)
HealthcareService	setNameElement(StringType value)
HealthcareService	setNotAvailable(List<HealthcareService.HealthcareServiceNotAvailableComponent> theNotAvailable)
HealthcareService	setPhoto(Attachment value)
HealthcareService	setProgramName(List<StringType> theProgramName)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
HealthcareService	setProvidedBy(Reference value)
HealthcareService	setProvidedByTarget(Organization value)
HealthcareService	setReferralMethod(List<CodeableConcept> theReferralMethod)
HealthcareService	setServiceProvisionCode(List<CodeableConcept> theServiceProvisionCode)
HealthcareService	setSpecialty(List<CodeableConcept> theSpecialty)
HealthcareService	setTelecom(List<ContactPoint> theTelecom)
HealthcareService	setType(List<CodeableConcept> theType)
protected HealthcareService	typedCopy()

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.dstu3.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

External identifiers for this item.

active

protected BooleanType active

Whether this healthcareservice record is in active use.

providedBy

protected Reference providedBy

The organization that provides this healthcare service.

providedByTarget

protected Organization providedByTarget

The actual object that is the target of the reference (The organization that provides this healthcare service.)

category

protected CodeableConcept category

Identifies the broad category of service being performed or delivered.

type

protected List<CodeableConcept> type

The specific type of service that may be delivered or performed.

specialty

protected List<CodeableConcept> specialty

Collection of specialties handled by the service site. This is more of a medical term.

location

protected List<Reference> location

The location(s) where this healthcare service may be provided.

locationTarget

protected List<Location> locationTarget

The actual objects that are the target of the reference (The location(s) where this healthcare service may be provided.)

name

protected StringType name

Further description of the service as it would be presented to a consumer while searching.

comment

protected StringType comment

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.

extraDetails

protected StringType extraDetails

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

photo

protected Attachment photo

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.

telecom

protected List<ContactPoint> telecom

List of contacts related to this specific healthcare service.

coverageArea

protected List<Reference> coverageArea

The location(s) that this service is available to (not where the service is provided).

coverageAreaTarget

protected List<Location> coverageAreaTarget

The actual objects that are the target of the reference (The location(s) that this service is available to (not where the service is provided).)

serviceProvisionCode

protected List<CodeableConcept> serviceProvisionCode

The code(s) that detail the conditions under which the healthcare service is available/offered.

eligibility

protected CodeableConcept eligibility

Does this service have specific eligibility requirements that need to be met in order to use the service?

eligibilityNote

protected StringType eligibilityNote

Describes the eligibility conditions for the service.

programName

protected List<StringType> programName

Program Names that can be used to categorize the service.

characteristic

protected List<CodeableConcept> characteristic

Collection of characteristics (attributes).

referralMethod

protected List<CodeableConcept> referralMethod

Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

appointmentRequired

protected BooleanType appointmentRequired

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.

availableTime

protected List<HealthcareService.HealthcareServiceAvailableTimeComponent> availableTime

A collection of times that the Service Site is available.

notAvailable

protected List<HealthcareService.HealthcareServiceNotAvailableComponent> notAvailable

The HealthcareService is not available during this period of time due to the provided reason.

availabilityExceptions

protected StringType availabilityExceptions

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.

endpoint

protected List<Reference> endpoint

Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

endpointTarget

protected List<Endpoint> endpointTarget

The actual objects that are the target of the reference (Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.)

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: External identifiers for this item
Type: token
Path: HealthcareService.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: External identifiers for this item
Type: token
Path: HealthcareService.identifier

SP_ENDPOINT

public static final String SP_ENDPOINT

Search parameter: endpoint

Description: Technical endpoints providing access to services operated for the location
Type: reference
Path: HealthcareService.endpoint

See Also:

• Constant Field Values

ENDPOINT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENDPOINT

Fluent Client search parameter constant for endpoint

Description: Technical endpoints providing access to services operated for the location
Type: reference
Path: HealthcareService.endpoint

INCLUDE_ENDPOINT

public static final ca.uhn.fhir.model.api.Include INCLUDE_ENDPOINT

Constant for fluent queries to be used to add include statements. Specifies the path value of "HealthcareService:endpoint".

SP_ORGANIZATION

public static final String SP_ORGANIZATION

Search parameter: organization

Description: The organization that provides this Healthcare Service
Type: reference
Path: HealthcareService.providedBy

See Also:

• Constant Field Values

ORGANIZATION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORGANIZATION

Fluent Client search parameter constant for organization

Description: The organization that provides this Healthcare Service
Type: reference
Path: HealthcareService.providedBy

INCLUDE_ORGANIZATION

public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "HealthcareService:organization".

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: A portion of the Healthcare service name
Type: string
Path: HealthcareService.name

See Also:

• Constant Field Values

NAME

public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME

Fluent Client search parameter constant for name

Description: A portion of the Healthcare service name
Type: string
Path: HealthcareService.name

SP_PROGRAMNAME

public static final String SP_PROGRAMNAME

Search parameter: programname

Description: One of the Program Names serviced by this HealthcareService
Type: string
Path: HealthcareService.programName

See Also:

• Constant Field Values

PROGRAMNAME

public static final ca.uhn.fhir.rest.gclient.StringClientParam PROGRAMNAME

Fluent Client search parameter constant for programname

Description: One of the Program Names serviced by this HealthcareService
Type: string
Path: HealthcareService.programName

SP_ACTIVE

public static final String SP_ACTIVE

Search parameter: active

Description: The Healthcare Service is currently marked as active
Type: token
Path: HealthcareService.active

See Also:

• Constant Field Values

ACTIVE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACTIVE

Fluent Client search parameter constant for active

Description: The Healthcare Service is currently marked as active
Type: token
Path: HealthcareService.active

SP_LOCATION

public static final String SP_LOCATION

Search parameter: location

Description: The location of the Healthcare Service
Type: reference
Path: HealthcareService.location

See Also:

• Constant Field Values

LOCATION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION

Fluent Client search parameter constant for location

Description: The location of the Healthcare Service
Type: reference
Path: HealthcareService.location

INCLUDE_LOCATION

public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "HealthcareService:location".

SP_CATEGORY

public static final String SP_CATEGORY

Search parameter: category

Description: Service Category of the Healthcare Service
Type: token
Path: HealthcareService.category

See Also:

• Constant Field Values

CATEGORY

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY

Fluent Client search parameter constant for category

Description: Service Category of the Healthcare Service
Type: token
Path: HealthcareService.category

SP_TYPE

public static final String SP_TYPE

Search parameter: type

Description: The type of service provided by this healthcare service
Type: token
Path: HealthcareService.type

See Also:

• Constant Field Values

TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE

Fluent Client search parameter constant for type

Description: The type of service provided by this healthcare service
Type: token
Path: HealthcareService.type

SP_CHARACTERISTIC

public static final String SP_CHARACTERISTIC

Search parameter: characteristic

Description: One of the HealthcareService's characteristics
Type: token
Path: HealthcareService.characteristic

See Also:

• Constant Field Values

CHARACTERISTIC

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CHARACTERISTIC

Fluent Client search parameter constant for characteristic

Description: One of the HealthcareService's characteristics
Type: token
Path: HealthcareService.characteristic

Constructor Details

HealthcareService

public HealthcareService()

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (External identifiers for this item.)

setIdentifier

public HealthcareService setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public HealthcareService addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getActiveElement

public BooleanType getActiveElement()

Returns:

active (Whether this healthcareservice record is in active use.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value

hasActiveElement

public boolean hasActiveElement()

hasActive

public boolean hasActive()

setActiveElement

public HealthcareService setActiveElement(BooleanType value)

Parameters:

value - active (Whether this healthcareservice record is in active use.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value

getActive

public boolean getActive()

Returns:

Whether this healthcareservice record is in active use.

setActive

public HealthcareService setActive(boolean value)

Parameters:

value - Whether this healthcareservice record is in active use.

getProvidedBy

public Reference getProvidedBy()

Returns:

providedBy (The organization that provides this healthcare service.)

hasProvidedBy

public boolean hasProvidedBy()

setProvidedBy

public HealthcareService setProvidedBy(Reference value)

Parameters:

value - providedBy (The organization that provides this healthcare service.)

getProvidedByTarget

public Organization getProvidedByTarget()

Returns:

providedBy The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The organization that provides this healthcare service.)

setProvidedByTarget

public HealthcareService setProvidedByTarget(Organization value)

Parameters:

value - providedBy The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The organization that provides this healthcare service.)

getCategory

public CodeableConcept getCategory()

Returns:

category (Identifies the broad category of service being performed or delivered.)

hasCategory

public boolean hasCategory()

setCategory

public HealthcareService setCategory(CodeableConcept value)

Parameters:

value - category (Identifies the broad category of service being performed or delivered.)

getType

public List<CodeableConcept> getType()

Returns:

type (The specific type of service that may be delivered or performed.)

setType

public HealthcareService setType(List<CodeableConcept> theType)

Returns:

Returns a reference to this for easy method chaining

hasType

public boolean hasType()

addType

public CodeableConcept addType()

addType

public HealthcareService addType(CodeableConcept t)

getTypeFirstRep

public CodeableConcept getTypeFirstRep()

Returns:

The first repetition of repeating field type, creating it if it does not already exist

getSpecialty

public List<CodeableConcept> getSpecialty()

Returns:

specialty (Collection of specialties handled by the service site. This is more of a medical term.)

setSpecialty

public HealthcareService setSpecialty(List<CodeableConcept> theSpecialty)

Returns:

Returns a reference to this for easy method chaining

hasSpecialty

public boolean hasSpecialty()

addSpecialty

public CodeableConcept addSpecialty()

addSpecialty

public HealthcareService addSpecialty(CodeableConcept t)

getSpecialtyFirstRep

public CodeableConcept getSpecialtyFirstRep()

Returns:

The first repetition of repeating field specialty, creating it if it does not already exist

getLocation

public List<Reference> getLocation()

Returns:

location (The location(s) where this healthcare service may be provided.)

setLocation

public HealthcareService setLocation(List<Reference> theLocation)

Returns:

Returns a reference to this for easy method chaining

hasLocation

public boolean hasLocation()

addLocation

public Reference addLocation()

addLocation

public HealthcareService addLocation(Reference t)

getLocationFirstRep

public Reference getLocationFirstRep()

Returns:

The first repetition of repeating field location, creating it if it does not already exist

getLocationTarget

@Deprecated
public List<Location> getLocationTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addLocationTarget

@Deprecated
public Location addLocationTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getNameElement

public StringType getNameElement()

Returns:

name (Further description of the service as it would be presented to a consumer while searching.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

hasNameElement

public boolean hasNameElement()

hasName

public boolean hasName()

setNameElement

public HealthcareService setNameElement(StringType value)

Parameters:

value - name (Further description of the service as it would be presented to a consumer while searching.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

getName

public String getName()

Returns:

Further description of the service as it would be presented to a consumer while searching.

setName

public HealthcareService setName(String value)

Parameters:

value - Further description of the service as it would be presented to a consumer while searching.

getCommentElement

public StringType getCommentElement()

Returns:

comment (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.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value

hasCommentElement

public boolean hasCommentElement()

hasComment

public boolean hasComment()

setCommentElement

public HealthcareService setCommentElement(StringType value)

Parameters:

value - comment (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.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value

getComment

public String getComment()

Returns:

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.

setComment

public HealthcareService setComment(String value)

Parameters:

value - 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.

getExtraDetailsElement

public StringType getExtraDetailsElement()

Returns:

extraDetails (Extra details about the service that can't be placed in the other fields.). This is the underlying object with id, value and extensions. The accessor "getExtraDetails" gives direct access to the value

hasExtraDetailsElement

public boolean hasExtraDetailsElement()

hasExtraDetails

public boolean hasExtraDetails()

setExtraDetailsElement

public HealthcareService setExtraDetailsElement(StringType value)

Parameters:

value - extraDetails (Extra details about the service that can't be placed in the other fields.). This is the underlying object with id, value and extensions. The accessor "getExtraDetails" gives direct access to the value

getExtraDetails

public String getExtraDetails()

Returns:

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

setExtraDetails

public HealthcareService setExtraDetails(String value)

Parameters:

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

getPhoto

public Attachment getPhoto()

Returns:

photo (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.)

hasPhoto

public boolean hasPhoto()

setPhoto

public HealthcareService setPhoto(Attachment value)

Parameters:

value - photo (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.)

getTelecom

public List<ContactPoint> getTelecom()

Returns:

telecom (List of contacts related to this specific healthcare service.)

setTelecom

public HealthcareService setTelecom(List<ContactPoint> theTelecom)

Returns:

Returns a reference to this for easy method chaining

hasTelecom

public boolean hasTelecom()

addTelecom

public ContactPoint addTelecom()

addTelecom

public HealthcareService addTelecom(ContactPoint t)

getTelecomFirstRep

public ContactPoint getTelecomFirstRep()

Returns:

The first repetition of repeating field telecom, creating it if it does not already exist

getCoverageArea

public List<Reference> getCoverageArea()

Returns:

coverageArea (The location(s) that this service is available to (not where the service is provided).)

setCoverageArea

public HealthcareService setCoverageArea(List<Reference> theCoverageArea)

Returns:

Returns a reference to this for easy method chaining

hasCoverageArea

public boolean hasCoverageArea()

addCoverageArea

public Reference addCoverageArea()

addCoverageArea

public HealthcareService addCoverageArea(Reference t)

getCoverageAreaFirstRep

public Reference getCoverageAreaFirstRep()

Returns:

The first repetition of repeating field coverageArea, creating it if it does not already exist

getCoverageAreaTarget

@Deprecated
public List<Location> getCoverageAreaTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addCoverageAreaTarget

@Deprecated
public Location addCoverageAreaTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getServiceProvisionCode

public List<CodeableConcept> getServiceProvisionCode()

Returns:

serviceProvisionCode (The code(s) that detail the conditions under which the healthcare service is available/offered.)

setServiceProvisionCode

public HealthcareService setServiceProvisionCode(List<CodeableConcept> theServiceProvisionCode)

Returns:

Returns a reference to this for easy method chaining

hasServiceProvisionCode

public boolean hasServiceProvisionCode()

addServiceProvisionCode

public CodeableConcept addServiceProvisionCode()

addServiceProvisionCode

public HealthcareService addServiceProvisionCode(CodeableConcept t)

getServiceProvisionCodeFirstRep

public CodeableConcept getServiceProvisionCodeFirstRep()

Returns:

The first repetition of repeating field serviceProvisionCode, creating it if it does not already exist

getEligibility

public CodeableConcept getEligibility()

Returns:

eligibility (Does this service have specific eligibility requirements that need to be met in order to use the service?)

hasEligibility

public boolean hasEligibility()

setEligibility

public HealthcareService setEligibility(CodeableConcept value)

Parameters:

value - eligibility (Does this service have specific eligibility requirements that need to be met in order to use the service?)

getEligibilityNoteElement

public StringType getEligibilityNoteElement()

Returns:

eligibilityNote (Describes the eligibility conditions for the service.). This is the underlying object with id, value and extensions. The accessor "getEligibilityNote" gives direct access to the value

hasEligibilityNoteElement

public boolean hasEligibilityNoteElement()

hasEligibilityNote

public boolean hasEligibilityNote()

setEligibilityNoteElement

public HealthcareService setEligibilityNoteElement(StringType value)

Parameters:

value - eligibilityNote (Describes the eligibility conditions for the service.). This is the underlying object with id, value and extensions. The accessor "getEligibilityNote" gives direct access to the value

getEligibilityNote

public String getEligibilityNote()

Returns:

Describes the eligibility conditions for the service.

setEligibilityNote

public HealthcareService setEligibilityNote(String value)

Parameters:

value - Describes the eligibility conditions for the service.

getProgramName

public List<StringType> getProgramName()

Returns:

programName (Program Names that can be used to categorize the service.)

setProgramName

public HealthcareService setProgramName(List<StringType> theProgramName)

Returns:

Returns a reference to this for easy method chaining

hasProgramName

public boolean hasProgramName()

addProgramNameElement

public StringType addProgramNameElement()

Returns:

programName (Program Names that can be used to categorize the service.)

addProgramName

public HealthcareService addProgramName(String value)

Parameters:

value - programName (Program Names that can be used to categorize the service.)

hasProgramName

public boolean hasProgramName(String value)

Parameters:

value - programName (Program Names that can be used to categorize the service.)

getCharacteristic

public List<CodeableConcept> getCharacteristic()

Returns:

characteristic (Collection of characteristics (attributes).)

setCharacteristic

public HealthcareService setCharacteristic(List<CodeableConcept> theCharacteristic)

Returns:

Returns a reference to this for easy method chaining

hasCharacteristic

public boolean hasCharacteristic()

addCharacteristic

public CodeableConcept addCharacteristic()

addCharacteristic

public HealthcareService addCharacteristic(CodeableConcept t)

getCharacteristicFirstRep

public CodeableConcept getCharacteristicFirstRep()

Returns:

The first repetition of repeating field characteristic, creating it if it does not already exist

getReferralMethod

public List<CodeableConcept> getReferralMethod()

Returns:

referralMethod (Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.)

setReferralMethod

public HealthcareService setReferralMethod(List<CodeableConcept> theReferralMethod)

Returns:

Returns a reference to this for easy method chaining

hasReferralMethod

public boolean hasReferralMethod()

addReferralMethod

public CodeableConcept addReferralMethod()

addReferralMethod

public HealthcareService addReferralMethod(CodeableConcept t)

getReferralMethodFirstRep

public CodeableConcept getReferralMethodFirstRep()

Returns:

The first repetition of repeating field referralMethod, creating it if it does not already exist

getAppointmentRequiredElement

public BooleanType getAppointmentRequiredElement()

Returns:

appointmentRequired (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.). This is the underlying object with id, value and extensions. The accessor "getAppointmentRequired" gives direct access to the value

hasAppointmentRequiredElement

public boolean hasAppointmentRequiredElement()

hasAppointmentRequired

public boolean hasAppointmentRequired()

setAppointmentRequiredElement

public HealthcareService setAppointmentRequiredElement(BooleanType value)

Parameters:

value - appointmentRequired (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.). This is the underlying object with id, value and extensions. The accessor "getAppointmentRequired" gives direct access to the value

getAppointmentRequired

public boolean getAppointmentRequired()

Returns:

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.

setAppointmentRequired

public HealthcareService setAppointmentRequired(boolean value)

Parameters:

value - 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.

getAvailableTime

public List<HealthcareService.HealthcareServiceAvailableTimeComponent> getAvailableTime()

Returns:

availableTime (A collection of times that the Service Site is available.)

setAvailableTime

public HealthcareService setAvailableTime(List<HealthcareService.HealthcareServiceAvailableTimeComponent> theAvailableTime)

Returns:

Returns a reference to this for easy method chaining

hasAvailableTime

public boolean hasAvailableTime()

addAvailableTime

public HealthcareService.HealthcareServiceAvailableTimeComponent addAvailableTime()

addAvailableTime

public HealthcareService addAvailableTime(HealthcareService.HealthcareServiceAvailableTimeComponent t)

getAvailableTimeFirstRep

public HealthcareService.HealthcareServiceAvailableTimeComponent getAvailableTimeFirstRep()

Returns:

The first repetition of repeating field availableTime, creating it if it does not already exist

getNotAvailable

public List<HealthcareService.HealthcareServiceNotAvailableComponent> getNotAvailable()

Returns:

notAvailable (The HealthcareService is not available during this period of time due to the provided reason.)

setNotAvailable

public HealthcareService setNotAvailable(List<HealthcareService.HealthcareServiceNotAvailableComponent> theNotAvailable)

Returns:

Returns a reference to this for easy method chaining

hasNotAvailable

public boolean hasNotAvailable()

addNotAvailable

public HealthcareService.HealthcareServiceNotAvailableComponent addNotAvailable()

addNotAvailable

public HealthcareService addNotAvailable(HealthcareService.HealthcareServiceNotAvailableComponent t)

getNotAvailableFirstRep

public HealthcareService.HealthcareServiceNotAvailableComponent getNotAvailableFirstRep()

Returns:

The first repetition of repeating field notAvailable, creating it if it does not already exist

getAvailabilityExceptionsElement

public StringType getAvailabilityExceptionsElement()

Returns:

availabilityExceptions (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.). This is the underlying object with id, value and extensions. The accessor "getAvailabilityExceptions" gives direct access to the value

hasAvailabilityExceptionsElement

public boolean hasAvailabilityExceptionsElement()

hasAvailabilityExceptions

public boolean hasAvailabilityExceptions()

setAvailabilityExceptionsElement

public HealthcareService setAvailabilityExceptionsElement(StringType value)

Parameters:

value - availabilityExceptions (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.). This is the underlying object with id, value and extensions. The accessor "getAvailabilityExceptions" gives direct access to the value

getAvailabilityExceptions

public String getAvailabilityExceptions()

Returns:

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.

setAvailabilityExceptions

public HealthcareService setAvailabilityExceptions(String value)

Parameters:

value - 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.

getEndpoint

public List<Reference> getEndpoint()

Returns:

endpoint (Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.)

setEndpoint

public HealthcareService setEndpoint(List<Reference> theEndpoint)

Returns:

Returns a reference to this for easy method chaining

hasEndpoint

public boolean hasEndpoint()

addEndpoint

public Reference addEndpoint()

addEndpoint

public HealthcareService addEndpoint(Reference t)

getEndpointFirstRep

public Reference getEndpointFirstRep()

Returns:

The first repetition of repeating field endpoint, creating it if it does not already exist

getEndpointTarget

@Deprecated
public List<Endpoint> getEndpointTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addEndpointTarget

@Deprecated
public Endpoint addEndpointTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public HealthcareService copy()

Specified by:

copy in class DomainResource

typedCopy

protected HealthcareService typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource