Class HealthcareService

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class HealthcareService
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR HealthcareService Resource (administrative.group)

    Definition: The details of a healthcare service available at a location.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/HealthcareService

    See Also:
    Serialized Form
    • Field Detail

      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description:
        Type: token
        Path: HealthcareService.identifier

      • SP_SERVICECATEGORY

        public static final String SP_SERVICECATEGORY
        Search parameter constant for servicecategory

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

        See Also:
        Constant Field Values
      • SERVICECATEGORY

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERVICECATEGORY
        Fluent Client search parameter constant for servicecategory

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

      • SP_SERVICETYPE

        public static final String SP_SERVICETYPE
        Search parameter constant for servicetype

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

        See Also:
        Constant Field Values
      • SERVICETYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SERVICETYPE
        Fluent Client search parameter constant for servicetype

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

      • SP_NAME

        public static final String SP_NAME
        Search parameter constant for name

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

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

      • SP_LOCATION

        public static final String SP_LOCATION
        Search parameter constant for 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

      • SP_ORGANIZATION

        public static final String SP_ORGANIZATION
        Search parameter constant for 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

      • SP_PROGRAMNAME

        public static final String SP_PROGRAMNAME
        Search parameter constant for programname

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

        See Also:
        Constant Field Values
      • PROGRAMNAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam PROGRAMNAME
        Fluent Client search parameter constant for programname

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

      • SP_CHARACTERISTIC

        public static final String SP_CHARACTERISTIC
        Search parameter constant for 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

      • 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".
      • 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".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

        Definition: External identifiers for this item

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier (id)

        Definition: External identifiers for this item

      • addIdentifier

        public HealthcareService addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition: External identifiers for this item

        Parameters:
        theValue - The identifier to add (must not be null)
      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (id), creating it if it does not already exist.

        Definition: External identifiers for this item

      • getProvidedBy

        public ResourceReferenceDt getProvidedBy()
        Gets the value(s) for providedBy (). creating it if it does not exist. Will not return null.

        Definition: The organization that provides this healthcare service

      • getServiceCategory

        public CodeableConceptDt getServiceCategory()
        Gets the value(s) for serviceCategory (class). creating it if it does not exist. Will not return null.

        Definition: Identifies the broad category of service being performed or delivered

      • getServiceType

        public List<HealthcareService.ServiceTypegetServiceType()
        Gets the value(s) for serviceType (). creating it if it does not exist. Will not return null.

        Definition: A specific type of service that may be delivered or performed

      • getLocation

        public ResourceReferenceDt getLocation()
        Gets the value(s) for location (where). creating it if it does not exist. Will not return null.

        Definition: The location where this healthcare service may be provided

      • getServiceNameElement

        public ca.uhn.fhir.model.primitive.StringDt getServiceNameElement()
        Gets the value(s) for serviceName (). creating it if it does not exist. Will not return null.

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

      • getServiceName

        public String getServiceName()
        Gets the value(s) for serviceName (). creating it if it does not exist. This method may return null.

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

      • setServiceName

        public HealthcareService setServiceName​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for serviceName ()

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

      • setServiceName

        public HealthcareService setServiceName​(String theString)
        Sets the value for serviceName ()

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

      • getCommentElement

        public ca.uhn.fhir.model.primitive.StringDt getCommentElement()
        Gets the value(s) for comment (). creating it if it does not exist. Will not return null.

        Definition: 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

      • getComment

        public String getComment()
        Gets the value(s) for comment (). creating it if it does not exist. This method may return null.

        Definition: 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​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for comment ()

        Definition: 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 theString)
        Sets the value for comment ()

        Definition: 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 ca.uhn.fhir.model.primitive.StringDt getExtraDetailsElement()
        Gets the value(s) for extraDetails (). creating it if it does not exist. Will not return null.

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

      • getExtraDetails

        public String getExtraDetails()
        Gets the value(s) for extraDetails (). creating it if it does not exist. This method may return null.

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

      • setExtraDetails

        public HealthcareService setExtraDetails​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for extraDetails ()

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

      • setExtraDetails

        public HealthcareService setExtraDetails​(String theString)
        Sets the value for extraDetails ()

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

      • getPhoto

        public AttachmentDt getPhoto()
        Gets the value(s) for photo (). creating it if it does not exist. Will not return null.

        Definition: 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

      • setPhoto

        public HealthcareService setPhoto​(AttachmentDt theValue)
        Sets the value(s) for photo ()

        Definition: If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list

      • getTelecom

        public List<ContactPointDtgetTelecom()
        Gets the value(s) for telecom (). creating it if it does not exist. Will not return null.

        Definition: List of contacts related to this specific healthcare service

      • addTelecom

        public ContactPointDt addTelecom()
        Adds and returns a new value for telecom ()

        Definition: List of contacts related to this specific healthcare service

      • addTelecom

        public HealthcareService addTelecom​(ContactPointDt theValue)
        Adds a given new value for telecom ()

        Definition: List of contacts related to this specific healthcare service

        Parameters:
        theValue - The telecom to add (must not be null)
      • getTelecomFirstRep

        public ContactPointDt getTelecomFirstRep()
        Gets the first repetition for telecom (), creating it if it does not already exist.

        Definition: List of contacts related to this specific healthcare service

      • getCoverageArea

        public List<ResourceReferenceDtgetCoverageArea()
        Gets the value(s) for coverageArea (). creating it if it does not exist. Will not return null.

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

      • addCoverageArea

        public ResourceReferenceDt addCoverageArea()
        Adds and returns a new value for coverageArea ()

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

      • getEligibility

        public CodeableConceptDt getEligibility()
        Gets the value(s) for eligibility (). creating it if it does not exist. Will not return null.

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

      • setEligibility

        public HealthcareService setEligibility​(CodeableConceptDt theValue)
        Sets the value(s) for eligibility ()

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

      • getEligibilityNoteElement

        public ca.uhn.fhir.model.primitive.StringDt getEligibilityNoteElement()
        Gets the value(s) for eligibilityNote (). creating it if it does not exist. Will not return null.

        Definition: Describes the eligibility conditions for the service

      • getEligibilityNote

        public String getEligibilityNote()
        Gets the value(s) for eligibilityNote (). creating it if it does not exist. This method may return null.

        Definition: Describes the eligibility conditions for the service

      • setEligibilityNote

        public HealthcareService setEligibilityNote​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for eligibilityNote ()

        Definition: Describes the eligibility conditions for the service

      • getProgramName

        public List<ca.uhn.fhir.model.primitive.StringDt> getProgramName()
        Gets the value(s) for programName (). creating it if it does not exist. Will not return null.

        Definition: Program Names that can be used to categorize the service

      • setProgramName

        public HealthcareService setProgramName​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
        Sets the value(s) for programName ()

        Definition: Program Names that can be used to categorize the service

      • addProgramName

        public ca.uhn.fhir.model.primitive.StringDt addProgramName()
        Adds and returns a new value for programName ()

        Definition: Program Names that can be used to categorize the service

      • addProgramName

        public HealthcareService addProgramName​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Adds a given new value for programName ()

        Definition: Program Names that can be used to categorize the service

        Parameters:
        theValue - The programName to add (must not be null)
      • getProgramNameFirstRep

        public ca.uhn.fhir.model.primitive.StringDt getProgramNameFirstRep()
        Gets the first repetition for programName (), creating it if it does not already exist.

        Definition: Program Names that can be used to categorize the service

      • addProgramName

        public HealthcareService addProgramName​(String theString)
        Adds a new value for programName ()

        Definition: Program Names that can be used to categorize the service

        Returns:
        Returns a reference to this object, to allow for simple chaining.
      • getCharacteristic

        public List<CodeableConceptDtgetCharacteristic()
        Gets the value(s) for characteristic (). creating it if it does not exist. Will not return null.

        Definition: Collection of characteristics (attributes)

      • addCharacteristic

        public CodeableConceptDt addCharacteristic()
        Adds and returns a new value for characteristic ()

        Definition: Collection of characteristics (attributes)

      • addCharacteristic

        public HealthcareService addCharacteristic​(CodeableConceptDt theValue)
        Adds a given new value for characteristic ()

        Definition: Collection of characteristics (attributes)

        Parameters:
        theValue - The characteristic to add (must not be null)
      • getCharacteristicFirstRep

        public CodeableConceptDt getCharacteristicFirstRep()
        Gets the first repetition for characteristic (), creating it if it does not already exist.

        Definition: Collection of characteristics (attributes)

      • getReferralMethod

        public List<BoundCodeableConceptDt<ReferralMethodEnum>> getReferralMethod()
        Gets the value(s) for referralMethod (). creating it if it does not exist. Will not return null.

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

      • addReferralMethod

        public BoundCodeableConceptDt<ReferralMethodEnumaddReferralMethod​(ReferralMethodEnum theValue)
        Add a value for referralMethod () using an enumerated type. This is intended as a convenience method for situations where the FHIR defined ValueSets are mandatory or contain the desirable codes. If you wish to use codes other than those which are built-in, you may also use the addReferralMethod() method.

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

      • setReferralMethod

        public HealthcareService setReferralMethod​(ReferralMethodEnum theValue)
        Sets the value(s), and clears any existing value(s) for referralMethod ()

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

      • getPublicKeyElement

        public ca.uhn.fhir.model.primitive.StringDt getPublicKeyElement()
        Gets the value(s) for publicKey (). creating it if it does not exist. Will not return null.

        Definition: 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

      • getPublicKey

        public String getPublicKey()
        Gets the value(s) for publicKey (). creating it if it does not exist. This method may return null.

        Definition: 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

        public HealthcareService setPublicKey​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for publicKey ()

        Definition: 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

        public HealthcareService setPublicKey​(String theString)
        Sets the value for publicKey ()

        Definition: 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

        public ca.uhn.fhir.model.primitive.BooleanDt getAppointmentRequiredElement()
        Gets the value(s) for appointmentRequired (). creating it if it does not exist. Will not return null.

        Definition: 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.

      • getAppointmentRequired

        public Boolean getAppointmentRequired()
        Gets the value(s) for appointmentRequired (). creating it if it does not exist. This method may return null.

        Definition: 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​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for appointmentRequired ()

        Definition: 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 theBoolean)
        Sets the value for appointmentRequired ()

        Definition: 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.

      • getNotAvailable

        public List<HealthcareService.NotAvailablegetNotAvailable()
        Gets the value(s) for notAvailable (). creating it if it does not exist. Will not return null.

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

      • addNotAvailable

        public HealthcareService.NotAvailable addNotAvailable()
        Adds and returns a new value for notAvailable ()

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

      • addNotAvailable

        public HealthcareService addNotAvailable​(HealthcareService.NotAvailable theValue)
        Adds a given new value for notAvailable ()

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

        Parameters:
        theValue - The notAvailable to add (must not be null)
      • getNotAvailableFirstRep

        public HealthcareService.NotAvailable getNotAvailableFirstRep()
        Gets the first repetition for notAvailable (), creating it if it does not already exist.

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

      • getAvailabilityExceptionsElement

        public ca.uhn.fhir.model.primitive.StringDt getAvailabilityExceptionsElement()
        Gets the value(s) for availabilityExceptions (). creating it if it does not exist. Will not return null.

        Definition: 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

      • getAvailabilityExceptions

        public String getAvailabilityExceptions()
        Gets the value(s) for availabilityExceptions (). creating it if it does not exist. This method may return null.

        Definition: A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times

      • setAvailabilityExceptions

        public HealthcareService setAvailabilityExceptions​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for availabilityExceptions ()

        Definition: A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times

      • setAvailabilityExceptions

        public HealthcareService setAvailabilityExceptions​(String theString)
        Sets the value for availabilityExceptions ()

        Definition: 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

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource