Class HealthcareService
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.HealthcareService
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class HealthcareService extends DomainResource
The details of a healthcare service available at a location.Maturity level: FMM2 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
HealthcareService.AvailableTime
A collection of times that the Service Site is available.static class
HealthcareService.Builder
static class
HealthcareService.Eligibility
Does this service have specific eligibility requirements that need to be met in order to use the service?static class
HealthcareService.NotAvailable
The HealthcareService is not available during this period of time due to the provided reason.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static HealthcareService.Builder
builder()
boolean
equals(java.lang.Object obj)
Boolean
getActive()
This flag is used to mark the record to not be used.Boolean
getAppointmentRequired()
Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization.String
getAvailabilityExceptions()
A description of site availability exceptions, e.g.java.util.List<HealthcareService.AvailableTime>
getAvailableTime()
A collection of times that the Service Site is available.java.util.List<CodeableConcept>
getCategory()
Identifies the broad category of service being performed or delivered.java.util.List<CodeableConcept>
getCharacteristic()
Collection of characteristics (attributes).String
getComment()
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.java.util.List<CodeableConcept>
getCommunication()
Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in.java.util.List<Reference>
getCoverageArea()
The location(s) that this service is available to (not where the service is provided).java.util.List<HealthcareService.Eligibility>
getEligibility()
Does this service have specific eligibility requirements that need to be met in order to use the service?java.util.List<Reference>
getEndpoint()
Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.Markdown
getExtraDetails()
Extra details about the service that can't be placed in the other fields.java.util.List<Identifier>
getIdentifier()
External identifiers for this item.java.util.List<Reference>
getLocation()
The location(s) where this healthcare service may be provided.String
getName()
Further description of the service as it would be presented to a consumer while searching.java.util.List<HealthcareService.NotAvailable>
getNotAvailable()
The HealthcareService is not available during this period of time due to the provided reason.Attachment
getPhoto()
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.java.util.List<CodeableConcept>
getProgram()
Programs that this service is applicable to.Reference
getProvidedBy()
The organization that provides this healthcare service.java.util.List<CodeableConcept>
getReferralMethod()
Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.java.util.List<CodeableConcept>
getServiceProvisionCode()
The code(s) that detail the conditions under which the healthcare service is available/offered.java.util.List<CodeableConcept>
getSpecialty()
Collection of specialties handled by the service site.java.util.List<ContactPoint>
getTelecom()
List of contacts related to this specific healthcare service.java.util.List<CodeableConcept>
getType()
The specific type of service that may be delivered or performed.boolean
hasChildren()
int
hashCode()
HealthcareService.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
External identifiers for this item.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getActive
public Boolean getActive()
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.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getProvidedBy
public Reference getProvidedBy()
The organization that provides this healthcare service.- Returns:
- An immutable object of type
Reference
that may be null.
-
getCategory
public java.util.List<CodeableConcept> getCategory()
Identifies the broad category of service being performed or delivered.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getType
public java.util.List<CodeableConcept> getType()
The specific type of service that may be delivered or performed.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getSpecialty
public java.util.List<CodeableConcept> getSpecialty()
Collection of specialties handled by the service site. This is more of a medical term.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getLocation
public java.util.List<Reference> getLocation()
The location(s) where this healthcare service may be provided.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getName
public String getName()
Further description of the service as it would be presented to a consumer while searching.- Returns:
- An immutable object of type
String
that may be null.
-
getComment
public String getComment()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getExtraDetails
public Markdown getExtraDetails()
Extra details about the service that can't be placed in the other fields.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getPhoto
public Attachment getPhoto()
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.- Returns:
- An immutable object of type
Attachment
that may be null.
-
getTelecom
public java.util.List<ContactPoint> getTelecom()
List of contacts related to this specific healthcare service.- Returns:
- An unmodifiable list containing immutable objects of type
ContactPoint
that may be empty.
-
getCoverageArea
public java.util.List<Reference> getCoverageArea()
The location(s) that this service is available to (not where the service is provided).- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getServiceProvisionCode
public java.util.List<CodeableConcept> getServiceProvisionCode()
The code(s) that detail the conditions under which the healthcare service is available/offered.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getEligibility
public java.util.List<HealthcareService.Eligibility> getEligibility()
Does this service have specific eligibility requirements that need to be met in order to use the service?- Returns:
- An unmodifiable list containing immutable objects of type
HealthcareService.Eligibility
that may be empty.
-
getProgram
public java.util.List<CodeableConcept> getProgram()
Programs that this service is applicable to.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getCharacteristic
public java.util.List<CodeableConcept> getCharacteristic()
Collection of characteristics (attributes).- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getCommunication
public java.util.List<CodeableConcept> getCommunication()
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.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getReferralMethod
public java.util.List<CodeableConcept> getReferralMethod()
Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getAppointmentRequired
public Boolean getAppointmentRequired()
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.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getAvailableTime
public java.util.List<HealthcareService.AvailableTime> getAvailableTime()
A collection of times that the Service Site is available.- Returns:
- An unmodifiable list containing immutable objects of type
HealthcareService.AvailableTime
that may be empty.
-
getNotAvailable
public java.util.List<HealthcareService.NotAvailable> getNotAvailable()
The HealthcareService is not available during this period of time due to the provided reason.- Returns:
- An unmodifiable list containing immutable objects of type
HealthcareService.NotAvailable
that may be empty.
-
getAvailabilityExceptions
public String getAvailabilityExceptions()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getEndpoint
public java.util.List<Reference> getEndpoint()
Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public HealthcareService.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static HealthcareService.Builder builder()
-
-