blob: 3bd951555faa62a2269a254b8c9a7ff9cf255a9f [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2016 David Carlson and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* David Carlson (Clinical Cloud Solutions, LLC) - initial API and implementation
*******************************************************************************/
/**
*/
package org.eclipse.mdht.uml.fhir.core.resource;
import org.eclipse.emf.common.util.EList;
import org.eclipse.mdht.uml.fhir.core.datatype.Attachment;
import org.eclipse.mdht.uml.fhir.core.datatype.CodeableConcept;
import org.eclipse.mdht.uml.fhir.core.datatype.ContactPoint;
import org.eclipse.mdht.uml.fhir.core.datatype.Identifier;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Healthcare Service</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
*
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getIdentifiers <em>Identifier</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getProvidedBy <em>Provided By</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getServiceCategory <em>Service Category</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getServiceTypes <em>Service Type</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getLocation <em>Location</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getServiceName <em>Service Name</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getComment <em>Comment</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getExtraDetails <em>Extra Details</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getPhoto <em>Photo</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getTelecoms <em>Telecom</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getCoverageAreas <em>Coverage Area</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getServiceProvisionCodes <em>Service Provision Code</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getEligibility <em>Eligibility</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getEligibilityNote <em>Eligibility Note</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getProgramNames <em>Program Name</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getCharacteristics <em>Characteristic</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getReferralMethods <em>Referral Method</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getPublicKey <em>Public Key</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getAppointmentRequired <em>Appointment Required</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getAvailableTimes <em>Available Time</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getNotAvailables <em>Not Available</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getAvailabilityExceptions <em>Availability Exceptions</em>}</li>
* </ul>
*
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService()
* @model
* @generated
*/
public interface HealthcareService extends DomainResource {
/**
* Returns the value of the '<em><b>Identifier</b></em>' reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.datatype.Identifier}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Identifier</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Identifier</em>' reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_Identifier()
* @model
* @generated
*/
EList<Identifier> getIdentifiers();
/**
* Returns the value of the '<em><b>Provided By</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Provided By</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Provided By</em>' reference.
* @see #setProvidedBy(Organization)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_ProvidedBy()
* @model
* @generated
*/
Organization getProvidedBy();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getProvidedBy <em>Provided By</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Provided By</em>' reference.
* @see #getProvidedBy()
* @generated
*/
void setProvidedBy(Organization value);
/**
* Returns the value of the '<em><b>Service Category</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Service Category</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Service Category</em>' reference.
* @see #setServiceCategory(CodeableConcept)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_ServiceCategory()
* @model
* @generated
*/
CodeableConcept getServiceCategory();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getServiceCategory <em>Service Category</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Service Category</em>' reference.
* @see #getServiceCategory()
* @generated
*/
void setServiceCategory(CodeableConcept value);
/**
* Returns the value of the '<em><b>Service Type</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareServiceServiceType}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Service Type</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Service Type</em>' containment reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_ServiceType()
* @model containment="true"
* @generated
*/
EList<HealthcareServiceServiceType> getServiceTypes();
/**
* Returns the value of the '<em><b>Location</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Location</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Location</em>' reference.
* @see #setLocation(Location)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_Location()
* @model required="true"
* @generated
*/
Location getLocation();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getLocation <em>Location</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Location</em>' reference.
* @see #getLocation()
* @generated
*/
void setLocation(Location value);
/**
* Returns the value of the '<em><b>Service Name</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Service Name</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Service Name</em>' reference.
* @see #setServiceName(org.eclipse.mdht.uml.fhir.core.datatype.String)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_ServiceName()
* @model
* @generated
*/
org.eclipse.mdht.uml.fhir.core.datatype.String getServiceName();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getServiceName <em>Service Name</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Service Name</em>' reference.
* @see #getServiceName()
* @generated
*/
void setServiceName(org.eclipse.mdht.uml.fhir.core.datatype.String value);
/**
* Returns the value of the '<em><b>Comment</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Comment</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Comment</em>' reference.
* @see #setComment(org.eclipse.mdht.uml.fhir.core.datatype.String)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_Comment()
* @model
* @generated
*/
org.eclipse.mdht.uml.fhir.core.datatype.String getComment();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getComment <em>Comment</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Comment</em>' reference.
* @see #getComment()
* @generated
*/
void setComment(org.eclipse.mdht.uml.fhir.core.datatype.String value);
/**
* Returns the value of the '<em><b>Extra Details</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Extra Details</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Extra Details</em>' reference.
* @see #setExtraDetails(org.eclipse.mdht.uml.fhir.core.datatype.String)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_ExtraDetails()
* @model
* @generated
*/
org.eclipse.mdht.uml.fhir.core.datatype.String getExtraDetails();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getExtraDetails <em>Extra Details</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Extra Details</em>' reference.
* @see #getExtraDetails()
* @generated
*/
void setExtraDetails(org.eclipse.mdht.uml.fhir.core.datatype.String value);
/**
* Returns the value of the '<em><b>Photo</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Photo</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Photo</em>' reference.
* @see #setPhoto(Attachment)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_Photo()
* @model
* @generated
*/
Attachment getPhoto();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getPhoto <em>Photo</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Photo</em>' reference.
* @see #getPhoto()
* @generated
*/
void setPhoto(Attachment value);
/**
* Returns the value of the '<em><b>Telecom</b></em>' reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.datatype.ContactPoint}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Telecom</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Telecom</em>' reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_Telecom()
* @model
* @generated
*/
EList<ContactPoint> getTelecoms();
/**
* Returns the value of the '<em><b>Coverage Area</b></em>' reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.resource.Location}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Coverage Area</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Coverage Area</em>' reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_CoverageArea()
* @model
* @generated
*/
EList<Location> getCoverageAreas();
/**
* Returns the value of the '<em><b>Service Provision Code</b></em>' reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.datatype.CodeableConcept}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Service Provision Code</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Service Provision Code</em>' reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_ServiceProvisionCode()
* @model
* @generated
*/
EList<CodeableConcept> getServiceProvisionCodes();
/**
* Returns the value of the '<em><b>Eligibility</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Eligibility</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Eligibility</em>' reference.
* @see #setEligibility(CodeableConcept)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_Eligibility()
* @model
* @generated
*/
CodeableConcept getEligibility();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getEligibility <em>Eligibility</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Eligibility</em>' reference.
* @see #getEligibility()
* @generated
*/
void setEligibility(CodeableConcept value);
/**
* Returns the value of the '<em><b>Eligibility Note</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Eligibility Note</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Eligibility Note</em>' reference.
* @see #setEligibilityNote(org.eclipse.mdht.uml.fhir.core.datatype.String)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_EligibilityNote()
* @model
* @generated
*/
org.eclipse.mdht.uml.fhir.core.datatype.String getEligibilityNote();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getEligibilityNote <em>Eligibility Note</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Eligibility Note</em>' reference.
* @see #getEligibilityNote()
* @generated
*/
void setEligibilityNote(org.eclipse.mdht.uml.fhir.core.datatype.String value);
/**
* Returns the value of the '<em><b>Program Name</b></em>' reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.datatype.String}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Program Name</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Program Name</em>' reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_ProgramName()
* @model
* @generated
*/
EList<org.eclipse.mdht.uml.fhir.core.datatype.String> getProgramNames();
/**
* Returns the value of the '<em><b>Characteristic</b></em>' reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.datatype.CodeableConcept}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Characteristic</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Characteristic</em>' reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_Characteristic()
* @model
* @generated
*/
EList<CodeableConcept> getCharacteristics();
/**
* Returns the value of the '<em><b>Referral Method</b></em>' reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.datatype.CodeableConcept}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Referral Method</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Referral Method</em>' reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_ReferralMethod()
* @model
* @generated
*/
EList<CodeableConcept> getReferralMethods();
/**
* Returns the value of the '<em><b>Public Key</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Public Key</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Public Key</em>' reference.
* @see #setPublicKey(org.eclipse.mdht.uml.fhir.core.datatype.String)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_PublicKey()
* @model
* @generated
*/
org.eclipse.mdht.uml.fhir.core.datatype.String getPublicKey();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getPublicKey <em>Public Key</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Public Key</em>' reference.
* @see #getPublicKey()
* @generated
*/
void setPublicKey(org.eclipse.mdht.uml.fhir.core.datatype.String value);
/**
* Returns the value of the '<em><b>Appointment Required</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Appointment Required</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Appointment Required</em>' reference.
* @see #setAppointmentRequired(org.eclipse.mdht.uml.fhir.core.datatype.Boolean)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_AppointmentRequired()
* @model
* @generated
*/
org.eclipse.mdht.uml.fhir.core.datatype.Boolean getAppointmentRequired();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getAppointmentRequired <em>Appointment Required</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Appointment Required</em>' reference.
* @see #getAppointmentRequired()
* @generated
*/
void setAppointmentRequired(org.eclipse.mdht.uml.fhir.core.datatype.Boolean value);
/**
* Returns the value of the '<em><b>Available Time</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareServiceAvailableTime}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Available Time</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Available Time</em>' containment reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_AvailableTime()
* @model containment="true"
* @generated
*/
EList<HealthcareServiceAvailableTime> getAvailableTimes();
/**
* Returns the value of the '<em><b>Not Available</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareServiceNotAvailable}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Not Available</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Not Available</em>' containment reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_NotAvailable()
* @model containment="true"
* @generated
*/
EList<HealthcareServiceNotAvailable> getNotAvailables();
/**
* Returns the value of the '<em><b>Availability Exceptions</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Availability Exceptions</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Availability Exceptions</em>' reference.
* @see #setAvailabilityExceptions(org.eclipse.mdht.uml.fhir.core.datatype.String)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getHealthcareService_AvailabilityExceptions()
* @model
* @generated
*/
org.eclipse.mdht.uml.fhir.core.datatype.String getAvailabilityExceptions();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.HealthcareService#getAvailabilityExceptions <em>Availability Exceptions</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Availability Exceptions</em>' reference.
* @see #getAvailabilityExceptions()
* @generated
*/
void setAvailabilityExceptions(org.eclipse.mdht.uml.fhir.core.datatype.String value);
} // HealthcareService