public class HealthcareService extends DomainResource
| Modifier and Type | Class and Description |
|---|---|
static class |
HealthcareService.DaysOfWeek |
static class |
HealthcareService.DaysOfWeekEnumFactory |
static class |
HealthcareService.HealthcareServiceAvailableTimeComponent |
static class |
HealthcareService.HealthcareServiceNotAvailableComponent |
| Modifier and Type | Field and Description |
|---|---|
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 List<CodeableConcept> |
characteristic
Collection of characteristics (attributes).
|
static 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 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 ca.uhn.fhir.rest.gclient.TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements.
|
static 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 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.)
|
static 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 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 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 StringType |
publicKey
The 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> |
referralMethod
Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
|
protected CodeableConcept |
serviceCategory
Identifies the broad category of service being performed or delivered.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
SERVICECATEGORY
Fluent Client search parameter constant for servicecategory
|
protected StringType |
serviceName
Further description of the service as it would be presented to a consumer while searching.
|
protected List<CodeableConcept> |
serviceProvisionCode
The code(s) that detail the conditions under which the healthcare service is available/offered.
|
protected List<CodeableConcept> |
serviceType
The specific type of service that may be delivered or performed.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
SERVICETYPE
Fluent Client search parameter constant for servicetype
|
static String |
SP_CHARACTERISTIC
Search parameter: characteristic
|
static String |
SP_IDENTIFIER
Search parameter: identifier
|
static String |
SP_LOCATION
Search parameter: location
|
static String |
SP_NAME
Search parameter: name
|
static String |
SP_ORGANIZATION
Search parameter: organization
|
static String |
SP_PROGRAMNAME
Search parameter: programname
|
static String |
SP_SERVICECATEGORY
Search parameter: servicecategory
|
static String |
SP_SERVICETYPE
Search parameter: servicetype
|
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.
|
contained, extension, modifierExtension, textid, implicitRules, language, meta| Constructor and Description |
|---|
HealthcareService()
Constructor
|
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setTextcopyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, setIdcastToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataprotected List<Identifier> identifier
protected Reference providedBy
protected Organization providedByTarget
protected CodeableConcept serviceCategory
protected List<CodeableConcept> serviceType
protected List<CodeableConcept> specialty
protected List<Reference> location
protected List<Location> locationTarget
protected StringType serviceName
protected StringType comment
protected StringType extraDetails
protected Attachment photo
protected List<ContactPoint> telecom
protected List<Reference> coverageArea
protected List<Location> coverageAreaTarget
protected List<CodeableConcept> serviceProvisionCode
protected CodeableConcept eligibility
protected StringType eligibilityNote
protected List<StringType> programName
protected List<CodeableConcept> characteristic
protected List<CodeableConcept> referralMethod
protected StringType publicKey
protected BooleanType appointmentRequired
protected List<HealthcareService.HealthcareServiceAvailableTimeComponent> availableTime
protected List<HealthcareService.HealthcareServiceNotAvailableComponent> notAvailable
protected StringType availabilityExceptions
public static final String SP_SERVICECATEGORY
Description: Service Category of the Healthcare Service
Type: token
Path: HealthcareService.serviceCategory
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERVICECATEGORY
Description: Service Category of the Healthcare Service
Type: token
Path: HealthcareService.serviceCategory
public static final String SP_ORGANIZATION
Description: The organization that provides this Healthcare Service
Type: reference
Path: HealthcareService.providedBy
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORGANIZATION
Description: The organization that provides this Healthcare Service
Type: reference
Path: HealthcareService.providedBy
public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION
public static final String SP_SERVICETYPE
Description: The type of service provided by this healthcare service
Type: token
Path: HealthcareService.serviceType
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERVICETYPE
Description: The type of service provided by this healthcare service
Type: token
Path: HealthcareService.serviceType
public static final String SP_LOCATION
Description: The location of the Healthcare Service
Type: reference
Path: HealthcareService.location
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION
Description: The location of the Healthcare Service
Type: reference
Path: HealthcareService.location
public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
public static final String SP_NAME
Description: A portion of the Healthcare service name
Type: string
Path: HealthcareService.serviceName
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Description: A portion of the Healthcare service name
Type: string
Path: HealthcareService.serviceName
public static final String SP_PROGRAMNAME
Description: One of the Program Names serviced by this HealthcareService
Type: string
Path: HealthcareService.programName
public static final ca.uhn.fhir.rest.gclient.StringClientParam PROGRAMNAME
Description: One of the Program Names serviced by this HealthcareService
Type: string
Path: HealthcareService.programName
public static final String SP_CHARACTERISTIC
Description: One of the HealthcareService's characteristics
Type: token
Path: HealthcareService.characteristic
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CHARACTERISTIC
Description: One of the HealthcareService's characteristics
Type: token
Path: HealthcareService.characteristic
public static final String SP_IDENTIFIER
Description: External identifiers for this item
Type: token
Path: HealthcareService.identifier
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Description: External identifiers for this item
Type: token
Path: HealthcareService.identifier
public HealthcareService()
public List<Identifier> getIdentifier()
identifier (External identifiers for this item.)public boolean hasIdentifier()
public Identifier addIdentifier()
identifier (External identifiers for this item.)public HealthcareService addIdentifier(Identifier t)
public Reference getProvidedBy()
providedBy (The organization that provides this healthcare service.)public boolean hasProvidedBy()
public HealthcareService setProvidedBy(Reference value)
value - providedBy (The organization that provides this healthcare service.)public Organization getProvidedByTarget()
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.)public HealthcareService setProvidedByTarget(Organization value)
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.)public CodeableConcept getServiceCategory()
serviceCategory (Identifies the broad category of service being performed or delivered.)public boolean hasServiceCategory()
public HealthcareService setServiceCategory(CodeableConcept value)
value - serviceCategory (Identifies the broad category of service being performed or delivered.)public List<CodeableConcept> getServiceType()
serviceType (The specific type of service that may be delivered or performed.)public boolean hasServiceType()
public CodeableConcept addServiceType()
serviceType (The specific type of service that may be delivered or performed.)public HealthcareService addServiceType(CodeableConcept t)
public List<CodeableConcept> getSpecialty()
specialty (Collection of specialties handled by the service site. This is more of a medical term.)public boolean hasSpecialty()
public CodeableConcept addSpecialty()
specialty (Collection of specialties handled by the service site. This is more of a medical term.)public HealthcareService addSpecialty(CodeableConcept t)
public List<Reference> getLocation()
location (The location(s) where this healthcare service may be provided.)public boolean hasLocation()
public Reference addLocation()
location (The location(s) where this healthcare service may be provided.)public HealthcareService addLocation(Reference t)
public List<Location> getLocationTarget()
location (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) where this healthcare service may be provided.)public Location addLocationTarget()
location (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) where this healthcare service may be provided.)public StringType getServiceNameElement()
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 valuepublic boolean hasServiceNameElement()
public boolean hasServiceName()
public HealthcareService setServiceNameElement(StringType value)
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 valuepublic String getServiceName()
public HealthcareService setServiceName(String value)
value - Further description of the service as it would be presented to a consumer while searching.public StringType getCommentElement()
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 valuepublic boolean hasCommentElement()
public boolean hasComment()
public HealthcareService setCommentElement(StringType value)
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 valuepublic String getComment()
public HealthcareService setComment(String value)
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.public StringType getExtraDetailsElement()
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 valuepublic boolean hasExtraDetailsElement()
public boolean hasExtraDetails()
public HealthcareService setExtraDetailsElement(StringType value)
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 valuepublic String getExtraDetails()
public HealthcareService setExtraDetails(String value)
value - Extra details about the service that can't be placed in the other fields.public Attachment getPhoto()
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.)public boolean hasPhoto()
public HealthcareService setPhoto(Attachment value)
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.)public List<ContactPoint> getTelecom()
telecom (List of contacts related to this specific healthcare service.)public boolean hasTelecom()
public ContactPoint addTelecom()
telecom (List of contacts related to this specific healthcare service.)public HealthcareService addTelecom(ContactPoint t)
public List<Reference> getCoverageArea()
coverageArea (The location(s) that this service is available to (not where the service is provided).)public boolean hasCoverageArea()
public Reference addCoverageArea()
coverageArea (The location(s) that this service is available to (not where the service is provided).)public HealthcareService addCoverageArea(Reference t)
public List<Location> getCoverageAreaTarget()
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).)public Location addCoverageAreaTarget()
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).)public List<CodeableConcept> getServiceProvisionCode()
serviceProvisionCode (The code(s) that detail the conditions under which the healthcare service is available/offered.)public boolean hasServiceProvisionCode()
public CodeableConcept addServiceProvisionCode()
serviceProvisionCode (The code(s) that detail the conditions under which the healthcare service is available/offered.)public HealthcareService addServiceProvisionCode(CodeableConcept t)
public CodeableConcept getEligibility()
eligibility (Does this service have specific eligibility requirements that need to be met in order to use the service?)public boolean hasEligibility()
public HealthcareService setEligibility(CodeableConcept value)
value - eligibility (Does this service have specific eligibility requirements that need to be met in order to use the service?)public StringType getEligibilityNoteElement()
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 valuepublic boolean hasEligibilityNoteElement()
public boolean hasEligibilityNote()
public HealthcareService setEligibilityNoteElement(StringType value)
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 valuepublic String getEligibilityNote()
public HealthcareService setEligibilityNote(String value)
value - Describes the eligibility conditions for the service.public List<StringType> getProgramName()
programName (Program Names that can be used to categorize the service.)public boolean hasProgramName()
public StringType addProgramNameElement()
programName (Program Names that can be used to categorize the service.)public HealthcareService addProgramName(String value)
value - programName (Program Names that can be used to categorize the service.)public boolean hasProgramName(String value)
value - programName (Program Names that can be used to categorize the service.)public List<CodeableConcept> getCharacteristic()
characteristic (Collection of characteristics (attributes).)public boolean hasCharacteristic()
public CodeableConcept addCharacteristic()
characteristic (Collection of characteristics (attributes).)public HealthcareService addCharacteristic(CodeableConcept t)
public List<CodeableConcept> getReferralMethod()
referralMethod (Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.)public boolean hasReferralMethod()
public CodeableConcept addReferralMethod()
referralMethod (Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.)public HealthcareService addReferralMethod(CodeableConcept t)
public StringType getPublicKeyElement()
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 valuepublic boolean hasPublicKeyElement()
public boolean hasPublicKey()
public HealthcareService setPublicKeyElement(StringType value)
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 valuepublic String getPublicKey()
public HealthcareService setPublicKey(String value)
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.public BooleanType getAppointmentRequiredElement()
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 valuepublic boolean hasAppointmentRequiredElement()
public boolean hasAppointmentRequired()
public HealthcareService setAppointmentRequiredElement(BooleanType value)
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 valuepublic boolean getAppointmentRequired()
public HealthcareService setAppointmentRequired(boolean value)
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.public List<HealthcareService.HealthcareServiceAvailableTimeComponent> getAvailableTime()
availableTime (A collection of times that the Service Site is available.)public boolean hasAvailableTime()
public HealthcareService.HealthcareServiceAvailableTimeComponent addAvailableTime()
availableTime (A collection of times that the Service Site is available.)public HealthcareService addAvailableTime(HealthcareService.HealthcareServiceAvailableTimeComponent t)
public List<HealthcareService.HealthcareServiceNotAvailableComponent> getNotAvailable()
notAvailable (The HealthcareService is not available during this period of time due to the provided reason.)public boolean hasNotAvailable()
public HealthcareService.HealthcareServiceNotAvailableComponent addNotAvailable()
notAvailable (The HealthcareService is not available during this period of time due to the provided reason.)public HealthcareService addNotAvailable(HealthcareService.HealthcareServiceNotAvailableComponent t)
public StringType getAvailabilityExceptionsElement()
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 valuepublic boolean hasAvailabilityExceptionsElement()
public boolean hasAvailabilityExceptions()
public HealthcareService setAvailabilityExceptionsElement(StringType value)
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 valuepublic String getAvailabilityExceptions()
public HealthcareService setAvailabilityExceptions(String value)
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.protected void listChildren(List<Property> childrenList)
listChildren in class DomainResourcepublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in class DomainResourcepublic HealthcareService copy()
copy in class DomainResourceprotected HealthcareService typedCopy()
public boolean equalsDeep(Base other)
equalsDeep in class DomainResourcepublic boolean equalsShallow(Base other)
equalsShallow in class DomainResourcepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class DomainResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2018 University Health Network. All rights reserved.