
Package org.hl7.fhir.dstu2.model
Class HealthcareService
java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.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
The details of a healthcare service available at a location.
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic enumstatic classstatic classstatic classstatic class
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected BooleanTypeIndicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization.protected StringTypeA description of site availability exceptions, e.g. public holiday availability.A collection of times that the Service Site is available.protected List<CodeableConcept> Collection of characteristics (attributes).protected StringTypeAny 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.The location(s) that this service is available to (not where the service is provided).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 CodeableConceptDoes this service have specific eligibility requirements that need to be met in order to use the service?protected StringTypeDescribes the eligibility conditions for the service.protected StringTypeExtra details about the service that can't be placed in the other fields.protected List<Identifier> External identifiers for this item.protected ReferenceThe location where this healthcare service may be provided.protected LocationThe actual object that is the target of the reference (The location where this healthcare service may be provided.)The HealthcareService is not available during this period of time due to the provided reason.protected AttachmentIf 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> Program Names that can be used to categorize the service.protected ReferenceThe organization that provides this healthcare service.protected OrganizationThe actual object that is the target of the reference (The organization that provides this healthcare service.)protected StringTypeThe public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet.protected List<CodeableConcept> Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.protected CodeableConceptIdentifies the broad category of service being performed or delivered.protected StringTypeFurther description of the service as it would be presented to a consumer while searching.protected List<CodeableConcept> The code(s) that detail the conditions under which the healthcare service is available/offered.protected List<HealthcareService.ServiceTypeComponent> A specific type of service that may be delivered or performed.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringprotected List<ContactPoint> List of contacts related to this specific healthcare service.Fields inherited from class org.hl7.fhir.dstu2.model.DomainResourcecontained, extension, modifierExtension, textFields inherited from class org.hl7.fhir.dstu2.model.Resourceid, implicitRules, language, metaFields inherited from interface org.hl7.fhir.instance.model.api.IAnyResourceRES_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_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResourceINCLUDE_ALL, WILDCARD_ALL_SET
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionaddProgramName(String value) copy()booleanequalsDeep(Base other) booleanequalsShallow(Base other) fhirType()booleangetPhoto()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasPhoto()booleanbooleanhasProgramName(String value) booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> childrenList) setAppointmentRequired(boolean value) setAvailabilityExceptions(String value) setComment(String value) setCommentElement(StringType value) setEligibility(CodeableConcept value) setEligibilityNote(String value) setExtraDetails(String value) setExtraDetailsElement(StringType value) setLocation(Reference value) setLocationTarget(Location value) setPhoto(Attachment value) voidsetProperty(String name, Base value) setProvidedBy(Reference value) setProvidedByTarget(Organization value) setPublicKey(String value) setPublicKeyElement(StringType value) setServiceName(String value) setServiceNameElement(StringType value) protected HealthcareServiceMethods inherited from class org.hl7.fhir.dstu2.model.DomainResourceaddContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setTextMethods inherited from class org.hl7.fhir.dstu2.model.ResourcecopyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetaMethods inherited from class org.hl7.fhir.dstu2.model.BaseResourcegetStructureFhirVersionEnum, setIdMethods inherited from class org.hl7.fhir.dstu2.model.BasecastToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINNMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResourcegetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBasegetFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResourcegetMeta, getStructureFhirVersionEnum, isDeleted, setId
- 
Field Details- 
identifierExternal identifiers for this item.
- 
providedByThe organization that provides this healthcare service.
- 
providedByTargetThe actual object that is the target of the reference (The organization that provides this healthcare service.)
- 
serviceCategoryIdentifies the broad category of service being performed or delivered.
- 
serviceTypeA specific type of service that may be delivered or performed.
- 
locationThe location where this healthcare service may be provided.
- 
locationTargetThe actual object that is the target of the reference (The location where this healthcare service may be provided.)
- 
serviceNameFurther description of the service as it would be presented to a consumer while searching.
- 
commentAny 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.
- 
extraDetailsExtra details about the service that can't be placed in the other fields.
- 
photoIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
- 
telecomList of contacts related to this specific healthcare service.
- 
coverageAreaThe location(s) that this service is available to (not where the service is provided).
- 
coverageAreaTargetThe actual objects that are the target of the reference (The location(s) that this service is available to (not where the service is provided).)
- 
serviceProvisionCodeThe code(s) that detail the conditions under which the healthcare service is available/offered.
- 
eligibilityDoes this service have specific eligibility requirements that need to be met in order to use the service?
- 
eligibilityNoteDescribes the eligibility conditions for the service.
- 
programNameProgram Names that can be used to categorize the service.
- 
characteristicCollection of characteristics (attributes).
- 
referralMethodWays that the service accepts referrals, if this is not provided then it is implied that no referral is required.
- 
publicKeyThe public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available.
- 
appointmentRequiredIndicates 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.
- 
availableTimeA collection of times that the Service Site is available.
- 
notAvailableThe HealthcareService is not available during this period of time due to the provided reason.
- 
availabilityExceptionsA 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.
- 
SP_IDENTIFIER- See Also:
 
- 
SP_SERVICECATEGORY- See Also:
 
- 
SP_SERVICETYPE- See Also:
 
- 
SP_ORGANIZATION- See Also:
 
- 
SP_NAME- See Also:
 
- 
SP_PROGRAMNAME- See Also:
 
- 
SP_LOCATION- See Also:
 
- 
SP_CHARACTERISTIC- See Also:
 
 
- 
- 
Constructor Details- 
HealthcareServicepublic HealthcareService()
- 
HealthcareService
 
- 
- 
Method Details- 
getIdentifier- Returns:
- identifier(External identifiers for this item.)
 
- 
hasIdentifier
- 
addIdentifier- Returns:
- identifier(External identifiers for this item.)
 
- 
addIdentifier
- 
getProvidedBy- Returns:
- providedBy(The organization that provides this healthcare service.)
 
- 
hasProvidedBy
- 
setProvidedBy- Parameters:
- value-- providedBy(The organization that provides this healthcare service.)
 
- 
getProvidedByTarget- Returns:
- providedByThe 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- Parameters:
- value-- providedByThe 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.)
 
- 
getServiceCategory- Returns:
- serviceCategory(Identifies the broad category of service being performed or delivered.)
 
- 
hasServiceCategory
- 
setServiceCategory- Parameters:
- value-- serviceCategory(Identifies the broad category of service being performed or delivered.)
 
- 
getServiceType- Returns:
- serviceType(A specific type of service that may be delivered or performed.)
 
- 
hasServiceType
- 
addServiceType- Returns:
- serviceType(A specific type of service that may be delivered or performed.)
 
- 
addServiceType
- 
getLocation- Returns:
- location(The location where this healthcare service may be provided.)
 
- 
hasLocation
- 
setLocation- Parameters:
- value-- location(The location where this healthcare service may be provided.)
 
- 
getLocationTarget- Returns:
- locationThe 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 location where this healthcare service may be provided.)
 
- 
setLocationTarget- Parameters:
- value-- locationThe 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 location where this healthcare service may be provided.)
 
- 
getServiceNameElement- Returns:
- serviceName(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 "getServiceName" gives direct access to the value
 
- 
hasServiceNameElement
- 
hasServiceName
- 
setServiceNameElement- Parameters:
- value-- serviceName(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 "getServiceName" gives direct access to the value
 
- 
getServiceName- Returns:
- Further description of the service as it would be presented to a consumer while searching.
 
- 
setServiceName- Parameters:
- value- Further description of the service as it would be presented to a consumer while searching.
 
- 
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
- 
hasComment
- 
setCommentElement- 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- 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- 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- 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
- 
hasExtraDetails
- 
setExtraDetailsElement- 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- Returns:
- Extra details about the service that can't be placed in the other fields.
 
- 
setExtraDetails- Parameters:
- value- Extra details about the service that can't be placed in the other fields.
 
- 
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
- 
setPhoto- 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- Returns:
- telecom(List of contacts related to this specific healthcare service.)
 
- 
hasTelecom
- 
addTelecom- Returns:
- telecom(List of contacts related to this specific healthcare service.)
 
- 
addTelecom
- 
getCoverageArea- Returns:
- coverageArea(The location(s) that this service is available to (not where the service is provided).)
 
- 
hasCoverageArea
- 
addCoverageArea- Returns:
- coverageArea(The location(s) that this service is available to (not where the service is provided).)
 
- 
addCoverageArea
- 
getCoverageAreaTarget- Returns:
- coverageArea(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. The location(s) that this service is available to (not where the service is provided).)
 
- 
addCoverageAreaTarget- Returns:
- coverageArea(Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. The location(s) that this service is available to (not where the service is provided).)
 
- 
getServiceProvisionCode- Returns:
- serviceProvisionCode(The code(s) that detail the conditions under which the healthcare service is available/offered.)
 
- 
hasServiceProvisionCode
- 
addServiceProvisionCode- Returns:
- serviceProvisionCode(The code(s) that detail the conditions under which the healthcare service is available/offered.)
 
- 
addServiceProvisionCode
- 
getEligibility- Returns:
- eligibility(Does this service have specific eligibility requirements that need to be met in order to use the service?)
 
- 
hasEligibility
- 
setEligibility- Parameters:
- value-- eligibility(Does this service have specific eligibility requirements that need to be met in order to use the service?)
 
- 
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
- 
hasEligibilityNote
- 
setEligibilityNoteElement- 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- Returns:
- Describes the eligibility conditions for the service.
 
- 
setEligibilityNote- Parameters:
- value- Describes the eligibility conditions for the service.
 
- 
getProgramName- Returns:
- programName(Program Names that can be used to categorize the service.)
 
- 
hasProgramName
- 
addProgramNameElement- Returns:
- programName(Program Names that can be used to categorize the service.)
 
- 
addProgramName- Parameters:
- value-- programName(Program Names that can be used to categorize the service.)
 
- 
hasProgramName- Parameters:
- value-- programName(Program Names that can be used to categorize the service.)
 
- 
getCharacteristic- Returns:
- characteristic(Collection of characteristics (attributes).)
 
- 
hasCharacteristic
- 
addCharacteristic- Returns:
- characteristic(Collection of characteristics (attributes).)
 
- 
addCharacteristic
- 
getReferralMethod- Returns:
- referralMethod(Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.)
 
- 
hasReferralMethod
- 
addReferralMethod- Returns:
- referralMethod(Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.)
 
- 
addReferralMethod
- 
getPublicKeyElement- Returns:
- publicKey(The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available.). This is the underlying object with id, value and extensions. The accessor "getPublicKey" gives direct access to the value
 
- 
hasPublicKeyElement
- 
hasPublicKey
- 
setPublicKeyElement- Parameters:
- value-- publicKey(The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available.). This is the underlying object with id, value and extensions. The accessor "getPublicKey" gives direct access to the value
 
- 
getPublicKey- Returns:
- The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available.
 
- 
setPublicKey- Parameters:
- value- The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available.
 
- 
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
- 
hasAppointmentRequired
- 
setAppointmentRequiredElement- 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- 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- 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- Returns:
- availableTime(A collection of times that the Service Site is available.)
 
- 
hasAvailableTime
- 
addAvailableTime- Returns:
- availableTime(A collection of times that the Service Site is available.)
 
- 
addAvailableTime
- 
getNotAvailable- Returns:
- notAvailable(The HealthcareService is not available during this period of time due to the provided reason.)
 
- 
hasNotAvailable
- 
addNotAvailable- Returns:
- notAvailable(The HealthcareService is not available during this period of time due to the provided reason.)
 
- 
addNotAvailable
- 
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
- 
hasAvailabilityExceptions
- 
setAvailabilityExceptionsElement- 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- 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- 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.
 
- 
listChildren- Overrides:
- listChildrenin class- DomainResource
 
- 
setProperty- Overrides:
- setPropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
addChild- Overrides:
- addChildin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
fhirType- Specified by:
- fhirTypein interface- org.hl7.fhir.instance.model.api.IBase
- Overrides:
- fhirTypein class- DomainResource
 
- 
copy- Specified by:
- copyin class- DomainResource
 
- 
typedCopy
- 
equalsDeep- Overrides:
- equalsDeepin class- DomainResource
 
- 
equalsShallow- Overrides:
- equalsShallowin class- DomainResource
 
- 
isEmpty- Specified by:
- isEmptyin interface- org.hl7.fhir.instance.model.api.IBase
- Overrides:
- isEmptyin class- DomainResource
 
- 
getResourceType- Specified by:
- getResourceTypein class- Resource
 
 
-