Package org.hl7.fhir.r5.model

Class HealthcareService

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.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 or in a catalog. In the case where there is a hierarchy of services (for example, Lab -> Pathology -> Wound Cultures), this can be represented using a set of linked HealthcareServices.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HealthcareService.HealthcareServiceEligibilityComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanType	active	This flag is used to mark the record to not be used.
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 List<Availability>	availability	A collection of times that the healthcare service is available.
protected List<CodeableConcept>	category	Identifies the broad category of service being performed or delivered.
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 MarkdownType	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<CodeableConcept>	communication	Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	COMMUNICATION	Fluent Client search parameter constant for communication
protected List<ExtendedContactDetail>	contact	The contact details of communication devices available relevant to the specific HealthcareService.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	COVERAGE_AREA	Fluent Client search parameter constant for coverage-area
protected List<Reference>	coverageArea	The location(s) that this service is available to (not where the service is provided).
protected List<HealthcareService.HealthcareServiceEligibilityComponent>	eligibility	Does this service have specific eligibility requirements that need to be met in order to use the service?
static final ca.uhn.fhir.rest.gclient.TokenClientParam	ELIGIBILITY	Fluent Client search parameter constant for eligibility
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 MarkdownType	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_COVERAGE_AREA	Constant for fluent queries to be used to add include statements.
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_OFFERED_IN	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 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
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	OFFERED_IN	Fluent Client search parameter constant for offered-in
protected List<Reference>	offeredIn	When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service.
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<CodeableConcept>	program	Programs that this service is applicable to.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PROGRAM	Fluent Client search parameter constant for program
protected Reference	providedBy	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.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SERVICE_CATEGORY	Fluent Client search parameter constant for service-category
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SERVICE_TYPE	Fluent Client search parameter constant for service-type
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_CHARACTERISTIC	Search parameter: characteristic
static final String	SP_COMMUNICATION	Search parameter: communication
static final String	SP_COVERAGE_AREA	Search parameter: coverage-area
static final String	SP_ELIGIBILITY	Search parameter: eligibility
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_OFFERED_IN	Search parameter: offered-in
static final String	SP_ORGANIZATION	Search parameter: organization
static final String	SP_PROGRAM	Search parameter: program
static final String	SP_SERVICE_CATEGORY	Search parameter: service-category
static final String	SP_SERVICE_TYPE	Search parameter: service-type
static final String	SP_SPECIALTY	Search parameter: specialty
protected List<CodeableConcept>	specialty	Collection of specialties handled by the Healthcare service.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SPECIALTY	Fluent Client search parameter constant for specialty
protected List<CodeableConcept>	type	The specific type of service that may be delivered or performed.

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.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
Availability	addAvailability()
HealthcareService	addAvailability(Availability t)
CodeableConcept	addCategory()
HealthcareService	addCategory(CodeableConcept t)
CodeableConcept	addCharacteristic()
HealthcareService	addCharacteristic(CodeableConcept t)
Base	addChild(String name)
CodeableConcept	addCommunication()
HealthcareService	addCommunication(CodeableConcept t)
ExtendedContactDetail	addContact()
HealthcareService	addContact(ExtendedContactDetail t)
Reference	addCoverageArea()
HealthcareService	addCoverageArea(Reference t)
HealthcareService.HealthcareServiceEligibilityComponent	addEligibility()
HealthcareService	addEligibility(HealthcareService.HealthcareServiceEligibilityComponent t)
Reference	addEndpoint()
HealthcareService	addEndpoint(Reference t)
Identifier	addIdentifier()
HealthcareService	addIdentifier(Identifier t)
Reference	addLocation()
HealthcareService	addLocation(Reference t)
Reference	addOfferedIn()
HealthcareService	addOfferedIn(Reference t)
CodeableConcept	addProgram()
HealthcareService	addProgram(CodeableConcept t)
CodeableConcept	addReferralMethod()
HealthcareService	addReferralMethod(CodeableConcept t)
CodeableConcept	addServiceProvisionCode()
HealthcareService	addServiceProvisionCode(CodeableConcept t)
CodeableConcept	addSpecialty()
HealthcareService	addSpecialty(CodeableConcept t)
CodeableConcept	addType()
HealthcareService	addType(CodeableConcept t)
HealthcareService	copy()
void	copyValues(HealthcareService dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getActive()
BooleanType	getActiveElement()
boolean	getAppointmentRequired()
BooleanType	getAppointmentRequiredElement()
List<Availability>	getAvailability()
Availability	getAvailabilityFirstRep()
List<CodeableConcept>	getCategory()
CodeableConcept	getCategoryFirstRep()
List<CodeableConcept>	getCharacteristic()
CodeableConcept	getCharacteristicFirstRep()
String	getComment()
MarkdownType	getCommentElement()
List<CodeableConcept>	getCommunication()
CodeableConcept	getCommunicationFirstRep()
List<ExtendedContactDetail>	getContact()
ExtendedContactDetail	getContactFirstRep()
List<Reference>	getCoverageArea()
Reference	getCoverageAreaFirstRep()
List<HealthcareService.HealthcareServiceEligibilityComponent>	getEligibility()
HealthcareService.HealthcareServiceEligibilityComponent	getEligibilityFirstRep()
List<Reference>	getEndpoint()
Reference	getEndpointFirstRep()
String	getExtraDetails()
MarkdownType	getExtraDetailsElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Reference>	getLocation()
Reference	getLocationFirstRep()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
List<Reference>	getOfferedIn()
Reference	getOfferedInFirstRep()
Attachment	getPhoto()
List<CodeableConcept>	getProgram()
CodeableConcept	getProgramFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
Reference	getProvidedBy()
List<CodeableConcept>	getReferralMethod()
CodeableConcept	getReferralMethodFirstRep()
ResourceType	getResourceType()
List<CodeableConcept>	getServiceProvisionCode()
CodeableConcept	getServiceProvisionCodeFirstRep()
List<CodeableConcept>	getSpecialty()
CodeableConcept	getSpecialtyFirstRep()
List<CodeableConcept>	getType()
CodeableConcept	getTypeFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasActive()
boolean	hasActiveElement()
boolean	hasAppointmentRequired()
boolean	hasAppointmentRequiredElement()
boolean	hasAvailability()
boolean	hasCategory()
boolean	hasCharacteristic()
boolean	hasComment()
boolean	hasCommentElement()
boolean	hasCommunication()
boolean	hasContact()
boolean	hasCoverageArea()
boolean	hasEligibility()
boolean	hasEndpoint()
boolean	hasExtraDetails()
boolean	hasExtraDetailsElement()
boolean	hasIdentifier()
boolean	hasLocation()
boolean	hasName()
boolean	hasNameElement()
boolean	hasOfferedIn()
boolean	hasPhoto()
boolean	hasProgram()
boolean	hasProvidedBy()
boolean	hasReferralMethod()
boolean	hasServiceProvisionCode()
boolean	hasSpecialty()
boolean	hasType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
HealthcareService	setActive(boolean value)
HealthcareService	setActiveElement(BooleanType value)
HealthcareService	setAppointmentRequired(boolean value)
HealthcareService	setAppointmentRequiredElement(BooleanType value)
HealthcareService	setAvailability(List<Availability> theAvailability)
HealthcareService	setCategory(List<CodeableConcept> theCategory)
HealthcareService	setCharacteristic(List<CodeableConcept> theCharacteristic)
HealthcareService	setComment(String value)
HealthcareService	setCommentElement(MarkdownType value)
HealthcareService	setCommunication(List<CodeableConcept> theCommunication)
HealthcareService	setContact(List<ExtendedContactDetail> theContact)
HealthcareService	setCoverageArea(List<Reference> theCoverageArea)
HealthcareService	setEligibility(List<HealthcareService.HealthcareServiceEligibilityComponent> theEligibility)
HealthcareService	setEndpoint(List<Reference> theEndpoint)
HealthcareService	setExtraDetails(String value)
HealthcareService	setExtraDetailsElement(MarkdownType value)
HealthcareService	setIdentifier(List<Identifier> theIdentifier)
HealthcareService	setLocation(List<Reference> theLocation)
HealthcareService	setName(String value)
HealthcareService	setNameElement(StringType value)
HealthcareService	setOfferedIn(List<Reference> theOfferedIn)
HealthcareService	setPhoto(Attachment value)
HealthcareService	setProgram(List<CodeableConcept> theProgram)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
HealthcareService	setProvidedBy(Reference value)
HealthcareService	setReferralMethod(List<CodeableConcept> theReferralMethod)
HealthcareService	setServiceProvisionCode(List<CodeableConcept> theServiceProvisionCode)
HealthcareService	setSpecialty(List<CodeableConcept> theSpecialty)
HealthcareService	setType(List<CodeableConcept> theType)
protected HealthcareService	typedCopy()

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

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

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

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

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

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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

This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

providedBy

protected Reference providedBy

The organization that provides this healthcare service.

offeredIn

protected List<Reference> offeredIn

When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service.

category

protected List<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 Healthcare service. This is more of a medical term.

location

protected List<Reference> location

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

contact

protected List<ExtendedContactDetail> contact

The contact details of communication devices available relevant to the specific HealthcareService. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

coverageArea

protected List<Reference> coverageArea

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 List<HealthcareService.HealthcareServiceEligibilityComponent> eligibility

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

program

protected List<CodeableConcept> program

Programs that this service is applicable to.

characteristic

protected List<CodeableConcept> characteristic

Collection of characteristics (attributes).

communication

protected List<CodeableConcept> communication

Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.

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.

availability

protected List<Availability> availability

A collection of times that the healthcare service is available.

endpoint

protected List<Reference> endpoint

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

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_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

SP_COMMUNICATION

public static final String SP_COMMUNICATION

Search parameter: communication

Description: Languages that are available at this service
Type: token
Path: HealthcareService.communication

See Also:

• Constant Field Values

COMMUNICATION

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

Fluent Client search parameter constant for communication

Description: Languages that are available at this service
Type: token
Path: HealthcareService.communication

SP_COVERAGE_AREA

public static final String SP_COVERAGE_AREA

Search parameter: coverage-area

Description: Location(s) service is intended for/available to
Type: reference
Path: HealthcareService.coverageArea

See Also:

• Constant Field Values

COVERAGE_AREA

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

Fluent Client search parameter constant for coverage-area

Description: Location(s) service is intended for/available to
Type: reference
Path: HealthcareService.coverageArea

INCLUDE_COVERAGE_AREA

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

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

SP_ELIGIBILITY

public static final String SP_ELIGIBILITY

Search parameter: eligibility

Description: One of the HealthcareService's eligibility requirements
Type: token
Path: HealthcareService.eligibility.code

See Also:

• Constant Field Values

ELIGIBILITY

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

Fluent Client search parameter constant for eligibility

Description: One of the HealthcareService's eligibility requirements
Type: token
Path: HealthcareService.eligibility.code

SP_ENDPOINT

public static final String SP_ENDPOINT

Search parameter: endpoint

Description: Technical endpoints providing access to electronic services operated for the healthcare service
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 electronic services operated for the healthcare service
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_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_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_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_OFFERED_IN

public static final String SP_OFFERED_IN

Search parameter: offered-in

Description: The service within which this service is offered
Type: reference
Path: HealthcareService.offeredIn

See Also:

• Constant Field Values

OFFERED_IN

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

Fluent Client search parameter constant for offered-in

Description: The service within which this service is offered
Type: reference
Path: HealthcareService.offeredIn

INCLUDE_OFFERED_IN

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

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

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_PROGRAM

public static final String SP_PROGRAM

Search parameter: program

Description: One of the Programs supported by this HealthcareService
Type: token
Path: HealthcareService.program

See Also:

• Constant Field Values

PROGRAM

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

Fluent Client search parameter constant for program

Description: One of the Programs supported by this HealthcareService
Type: token
Path: HealthcareService.program

SP_SERVICE_CATEGORY

public static final String SP_SERVICE_CATEGORY

Search parameter: service-category

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

See Also:

• Constant Field Values

SERVICE_CATEGORY

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

Fluent Client search parameter constant for service-category

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

SP_SERVICE_TYPE

public static final String SP_SERVICE_TYPE

Search parameter: service-type

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

See Also:

• Constant Field Values

SERVICE_TYPE

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

Fluent Client search parameter constant for service-type

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

SP_SPECIALTY

public static final String SP_SPECIALTY

Search parameter: specialty

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

See Also:

• Constant Field Values

SPECIALTY

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

Fluent Client search parameter constant for specialty

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

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 {3}

getActiveElement

public BooleanType getActiveElement()

Returns:

active (This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.). 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 (This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value

getActive

public boolean getActive()

Returns:

This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

setActive

public HealthcareService setActive(boolean value)

Parameters:

value - This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

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

getOfferedIn

public List<Reference> getOfferedIn()

Returns:

offeredIn (When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service.)

setOfferedIn

public HealthcareService setOfferedIn(List<Reference> theOfferedIn)

Returns:

Returns a reference to this for easy method chaining

hasOfferedIn

public boolean hasOfferedIn()

addOfferedIn

public Reference addOfferedIn()

addOfferedIn

public HealthcareService addOfferedIn(Reference t)

getOfferedInFirstRep

public Reference getOfferedInFirstRep()

Returns:

The first repetition of repeating field offeredIn, creating it if it does not already exist {3}

getCategory

public List<CodeableConcept> getCategory()

Returns:

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

setCategory

public HealthcareService setCategory(List<CodeableConcept> theCategory)

Returns:

Returns a reference to this for easy method chaining

hasCategory

public boolean hasCategory()

addCategory

public CodeableConcept addCategory()

addCategory

public HealthcareService addCategory(CodeableConcept t)

getCategoryFirstRep

public CodeableConcept getCategoryFirstRep()

Returns:

The first repetition of repeating field category, creating it if it does not already exist {3}

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 {3}

getSpecialty

public List<CodeableConcept> getSpecialty()

Returns:

specialty (Collection of specialties handled by the Healthcare service. 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 {3}

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 {3}

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

getContact

public List<ExtendedContactDetail> getContact()

Returns:

contact (The contact details of communication devices available relevant to the specific HealthcareService. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.)

setContact

public HealthcareService setContact(List<ExtendedContactDetail> theContact)

Returns:

Returns a reference to this for easy method chaining

hasContact

public boolean hasContact()

addContact

public ExtendedContactDetail addContact()

addContact

public HealthcareService addContact(ExtendedContactDetail t)

getContactFirstRep

public ExtendedContactDetail getContactFirstRep()

Returns:

The first repetition of repeating field contact, creating it if it does not already exist {3}

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 {3}

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 {3}

getEligibility

public List<HealthcareService.HealthcareServiceEligibilityComponent> getEligibility()

Returns:

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

setEligibility

public HealthcareService setEligibility(List<HealthcareService.HealthcareServiceEligibilityComponent> theEligibility)

Returns:

Returns a reference to this for easy method chaining

hasEligibility

public boolean hasEligibility()

addEligibility

public HealthcareService.HealthcareServiceEligibilityComponent addEligibility()

addEligibility

public HealthcareService addEligibility(HealthcareService.HealthcareServiceEligibilityComponent t)

getEligibilityFirstRep

public HealthcareService.HealthcareServiceEligibilityComponent getEligibilityFirstRep()

Returns:

The first repetition of repeating field eligibility, creating it if it does not already exist {3}

getProgram

public List<CodeableConcept> getProgram()

Returns:

program (Programs that this service is applicable to.)

setProgram

public HealthcareService setProgram(List<CodeableConcept> theProgram)

Returns:

Returns a reference to this for easy method chaining

hasProgram

public boolean hasProgram()

addProgram

public CodeableConcept addProgram()

addProgram

public HealthcareService addProgram(CodeableConcept t)

getProgramFirstRep

public CodeableConcept getProgramFirstRep()

Returns:

The first repetition of repeating field program, creating it if it does not already exist {3}

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 {3}

getCommunication

public List<CodeableConcept> getCommunication()

Returns:

communication (Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.)

setCommunication

public HealthcareService setCommunication(List<CodeableConcept> theCommunication)

Returns:

Returns a reference to this for easy method chaining

hasCommunication

public boolean hasCommunication()

addCommunication

public CodeableConcept addCommunication()

addCommunication

public HealthcareService addCommunication(CodeableConcept t)

getCommunicationFirstRep

public CodeableConcept getCommunicationFirstRep()

Returns:

The first repetition of repeating field communication, creating it if it does not already exist {3}

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 {3}

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.

getAvailability

public List<Availability> getAvailability()

Returns:

availability (A collection of times that the healthcare service is available.)

setAvailability

public HealthcareService setAvailability(List<Availability> theAvailability)

Returns:

Returns a reference to this for easy method chaining

hasAvailability

public boolean hasAvailability()

addAvailability

public Availability addAvailability()

addAvailability

public HealthcareService addAvailability(Availability t)

getAvailabilityFirstRep

public Availability getAvailabilityFirstRep()

Returns:

The first repetition of repeating field availability, creating it if it does not already exist {3}

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 {3}

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

removeChild

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

Overrides:

removeChild 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

Returns:

the FHIR type name of the instance (not the java class name)

copy

public HealthcareService copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(HealthcareService dst)

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