| /** |
| */ |
| package org.hl7.fhir; |
| |
| import org.eclipse.emf.common.util.EList; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Data Element</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * The formal description of a single piece of information that can be gathered and reported. |
| * If the element is present, it must have either a @value, an @id, or extensions |
| * <!-- end-model-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * </p> |
| * <ul> |
| * <li>{@link org.hl7.fhir.DataElement#getUrl <em>Url</em>}</li> |
| * <li>{@link org.hl7.fhir.DataElement#getIdentifier <em>Identifier</em>}</li> |
| * <li>{@link org.hl7.fhir.DataElement#getVersion <em>Version</em>}</li> |
| * <li>{@link org.hl7.fhir.DataElement#getName <em>Name</em>}</li> |
| * <li>{@link org.hl7.fhir.DataElement#getStatus <em>Status</em>}</li> |
| * <li>{@link org.hl7.fhir.DataElement#getExperimental <em>Experimental</em>}</li> |
| * <li>{@link org.hl7.fhir.DataElement#getPublisher <em>Publisher</em>}</li> |
| * <li>{@link org.hl7.fhir.DataElement#getContact <em>Contact</em>}</li> |
| * <li>{@link org.hl7.fhir.DataElement#getDate <em>Date</em>}</li> |
| * <li>{@link org.hl7.fhir.DataElement#getUseContext <em>Use Context</em>}</li> |
| * <li>{@link org.hl7.fhir.DataElement#getCopyright <em>Copyright</em>}</li> |
| * <li>{@link org.hl7.fhir.DataElement#getStringency <em>Stringency</em>}</li> |
| * <li>{@link org.hl7.fhir.DataElement#getMapping <em>Mapping</em>}</li> |
| * <li>{@link org.hl7.fhir.DataElement#getElement <em>Element</em>}</li> |
| * </ul> |
| * |
| * @see org.hl7.fhir.FhirPackage#getDataElement() |
| * @model extendedMetaData="name='DataElement' kind='elementOnly'" |
| * @generated |
| */ |
| public interface DataElement extends DomainResource { |
| /** |
| * Returns the value of the '<em><b>Url</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * An absolute URL that is used to identify this data element when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this data element is (or will be) published. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Url</em>' containment reference. |
| * @see #setUrl(Uri) |
| * @see org.hl7.fhir.FhirPackage#getDataElement_Url() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='url' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Uri getUrl(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.DataElement#getUrl <em>Url</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Url</em>' containment reference. |
| * @see #getUrl() |
| * @generated |
| */ |
| void setUrl(Uri value); |
| |
| /** |
| * Returns the value of the '<em><b>Identifier</b></em>' containment reference list. |
| * The list contents are of type {@link org.hl7.fhir.Identifier}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Formal identifier that is used to identify this data element when it is represented in other formats, or referenced in a specification, model, design or an instance. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Identifier</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getDataElement_Identifier() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='identifier' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<Identifier> getIdentifier(); |
| |
| /** |
| * Returns the value of the '<em><b>Version</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The identifier that is used to identify this version of the data element when it is referenced in a StructureDefinition, Questionnaire or instance. This is an arbitrary value managed by the definition author manually. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Version</em>' containment reference. |
| * @see #setVersion(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getDataElement_Version() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='version' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getVersion(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.DataElement#getVersion <em>Version</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Version</em>' containment reference. |
| * @see #getVersion() |
| * @generated |
| */ |
| void setVersion(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Name</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The term used by humans to refer to the data element. Should ideally be unique within the context in which the data element is expected to be used. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Name</em>' containment reference. |
| * @see #setName(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getDataElement_Name() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='name' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getName(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.DataElement#getName <em>Name</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Name</em>' containment reference. |
| * @see #getName() |
| * @generated |
| */ |
| void setName(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Status</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The status of the data element. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Status</em>' containment reference. |
| * @see #setStatus(Code) |
| * @see org.hl7.fhir.FhirPackage#getDataElement_Status() |
| * @model containment="true" required="true" |
| * extendedMetaData="kind='element' name='status' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Code getStatus(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.DataElement#getStatus <em>Status</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Status</em>' containment reference. |
| * @see #getStatus() |
| * @generated |
| */ |
| void setStatus(Code value); |
| |
| /** |
| * Returns the value of the '<em><b>Experimental</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A flag to indicate that this search data element definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Experimental</em>' containment reference. |
| * @see #setExperimental(org.hl7.fhir.Boolean) |
| * @see org.hl7.fhir.FhirPackage#getDataElement_Experimental() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='experimental' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.Boolean getExperimental(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.DataElement#getExperimental <em>Experimental</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Experimental</em>' containment reference. |
| * @see #getExperimental() |
| * @generated |
| */ |
| void setExperimental(org.hl7.fhir.Boolean value); |
| |
| /** |
| * Returns the value of the '<em><b>Publisher</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The name of the individual or organization that published the data element. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Publisher</em>' containment reference. |
| * @see #setPublisher(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getDataElement_Publisher() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='publisher' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getPublisher(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.DataElement#getPublisher <em>Publisher</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Publisher</em>' containment reference. |
| * @see #getPublisher() |
| * @generated |
| */ |
| void setPublisher(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Contact</b></em>' containment reference list. |
| * The list contents are of type {@link org.hl7.fhir.DataElementContact}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Contacts to assist a user in finding and communicating with the publisher. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Contact</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getDataElement_Contact() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='contact' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<DataElementContact> getContact(); |
| |
| /** |
| * Returns the value of the '<em><b>Date</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The date this version of the data element was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the data element changes. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Date</em>' containment reference. |
| * @see #setDate(DateTime) |
| * @see org.hl7.fhir.FhirPackage#getDataElement_Date() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='date' namespace='##targetNamespace'" |
| * @generated |
| */ |
| DateTime getDate(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.DataElement#getDate <em>Date</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Date</em>' containment reference. |
| * @see #getDate() |
| * @generated |
| */ |
| void setDate(DateTime value); |
| |
| /** |
| * Returns the value of the '<em><b>Use Context</b></em>' containment reference list. |
| * The list contents are of type {@link org.hl7.fhir.CodeableConcept}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of data element definitions. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Use Context</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getDataElement_UseContext() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='useContext' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<CodeableConcept> getUseContext(); |
| |
| /** |
| * Returns the value of the '<em><b>Copyright</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A copyright statement relating to the definition of the data element. Copyright statements are generally legal restrictions on the use and publishing of the details of the definition of the data element. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Copyright</em>' containment reference. |
| * @see #setCopyright(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getDataElement_Copyright() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='copyright' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getCopyright(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.DataElement#getCopyright <em>Copyright</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Copyright</em>' containment reference. |
| * @see #getCopyright() |
| * @generated |
| */ |
| void setCopyright(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Stringency</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Identifies how precise the data element is in its definition. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Stringency</em>' containment reference. |
| * @see #setStringency(DataElementStringency) |
| * @see org.hl7.fhir.FhirPackage#getDataElement_Stringency() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='stringency' namespace='##targetNamespace'" |
| * @generated |
| */ |
| DataElementStringency getStringency(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.DataElement#getStringency <em>Stringency</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Stringency</em>' containment reference. |
| * @see #getStringency() |
| * @generated |
| */ |
| void setStringency(DataElementStringency value); |
| |
| /** |
| * Returns the value of the '<em><b>Mapping</b></em>' containment reference list. |
| * The list contents are of type {@link org.hl7.fhir.DataElementMapping}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Mapping</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getDataElement_Mapping() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='mapping' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<DataElementMapping> getMapping(); |
| |
| /** |
| * Returns the value of the '<em><b>Element</b></em>' containment reference list. |
| * The list contents are of type {@link org.hl7.fhir.ElementDefinition}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Defines the structure, type, allowed values and other constraining characteristics of the data element. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Element</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getDataElement_Element() |
| * @model containment="true" required="true" |
| * extendedMetaData="kind='element' name='element' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<ElementDefinition> getElement(); |
| |
| } // DataElement |
