| /** |
| */ |
| package org.hl7.fhir; |
| |
| import org.eclipse.emf.common.util.EList; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Address</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. |
| * If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions |
| * <!-- end-model-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * </p> |
| * <ul> |
| * <li>{@link org.hl7.fhir.Address#getUse <em>Use</em>}</li> |
| * <li>{@link org.hl7.fhir.Address#getType <em>Type</em>}</li> |
| * <li>{@link org.hl7.fhir.Address#getText <em>Text</em>}</li> |
| * <li>{@link org.hl7.fhir.Address#getLine <em>Line</em>}</li> |
| * <li>{@link org.hl7.fhir.Address#getCity <em>City</em>}</li> |
| * <li>{@link org.hl7.fhir.Address#getDistrict <em>District</em>}</li> |
| * <li>{@link org.hl7.fhir.Address#getState <em>State</em>}</li> |
| * <li>{@link org.hl7.fhir.Address#getPostalCode <em>Postal Code</em>}</li> |
| * <li>{@link org.hl7.fhir.Address#getCountry <em>Country</em>}</li> |
| * <li>{@link org.hl7.fhir.Address#getPeriod <em>Period</em>}</li> |
| * </ul> |
| * |
| * @see org.hl7.fhir.FhirPackage#getAddress() |
| * @model extendedMetaData="name='Address' kind='elementOnly'" |
| * @generated |
| */ |
| public interface Address extends Element { |
| /** |
| * Returns the value of the '<em><b>Use</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The purpose of this address. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Use</em>' containment reference. |
| * @see #setUse(AddressUse) |
| * @see org.hl7.fhir.FhirPackage#getAddress_Use() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='use' namespace='##targetNamespace'" |
| * @generated |
| */ |
| AddressUse getUse(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.Address#getUse <em>Use</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Use</em>' containment reference. |
| * @see #getUse() |
| * @generated |
| */ |
| void setUse(AddressUse value); |
| |
| /** |
| * Returns the value of the '<em><b>Type</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Type</em>' containment reference. |
| * @see #setType(AddressType) |
| * @see org.hl7.fhir.FhirPackage#getAddress_Type() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='type' namespace='##targetNamespace'" |
| * @generated |
| */ |
| AddressType getType(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.Address#getType <em>Type</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Type</em>' containment reference. |
| * @see #getType() |
| * @generated |
| */ |
| void setType(AddressType value); |
| |
| /** |
| * Returns the value of the '<em><b>Text</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Text</em>' containment reference. |
| * @see #setText(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getAddress_Text() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='text' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getText(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.Address#getText <em>Text</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Text</em>' containment reference. |
| * @see #getText() |
| * @generated |
| */ |
| void setText(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Line</b></em>' containment reference list. |
| * The list contents are of type {@link org.hl7.fhir.String}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Line</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getAddress_Line() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='line' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<org.hl7.fhir.String> getLine(); |
| |
| /** |
| * Returns the value of the '<em><b>City</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The name of the city, town, suburb, village or other community or delivery center. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>City</em>' containment reference. |
| * @see #setCity(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getAddress_City() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='city' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getCity(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.Address#getCity <em>City</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>City</em>' containment reference. |
| * @see #getCity() |
| * @generated |
| */ |
| void setCity(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>District</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The name of the administrative area (county). |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>District</em>' containment reference. |
| * @see #setDistrict(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getAddress_District() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='district' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getDistrict(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.Address#getDistrict <em>District</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>District</em>' containment reference. |
| * @see #getDistrict() |
| * @generated |
| */ |
| void setDistrict(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>State</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>State</em>' containment reference. |
| * @see #setState(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getAddress_State() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='state' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getState(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.Address#getState <em>State</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>State</em>' containment reference. |
| * @see #getState() |
| * @generated |
| */ |
| void setState(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Postal Code</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A postal code designating a region defined by the postal service. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Postal Code</em>' containment reference. |
| * @see #setPostalCode(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getAddress_PostalCode() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='postalCode' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getPostalCode(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.Address#getPostalCode <em>Postal Code</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Postal Code</em>' containment reference. |
| * @see #getPostalCode() |
| * @generated |
| */ |
| void setPostalCode(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Country</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Country - a nation as commonly understood or generally accepted. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Country</em>' containment reference. |
| * @see #setCountry(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getAddress_Country() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='country' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getCountry(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.Address#getCountry <em>Country</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Country</em>' containment reference. |
| * @see #getCountry() |
| * @generated |
| */ |
| void setCountry(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Period</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Time period when address was/is in use. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Period</em>' containment reference. |
| * @see #setPeriod(Period) |
| * @see org.hl7.fhir.FhirPackage#getAddress_Period() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='period' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Period getPeriod(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.Address#getPeriod <em>Period</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Period</em>' containment reference. |
| * @see #getPeriod() |
| * @generated |
| */ |
| void setPeriod(Period value); |
| |
| } // Address |
