| /** |
| */ |
| package org.hl7.fhir; |
| |
| import org.eclipse.emf.common.util.EList; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Module Metadata</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * The ModuleMetadata resource defines the common metadata elements used by quality improvement artifacts. This information includes descriptive and topical metadata to enable repository searches, as well as governance and evidentiary support information. |
| * 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.ModuleMetadata#getIdentifier <em>Identifier</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getVersion <em>Version</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getTitle <em>Title</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getType <em>Type</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getStatus <em>Status</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getDescription <em>Description</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getPurpose <em>Purpose</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getUsage <em>Usage</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getPublicationDate <em>Publication Date</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getLastReviewDate <em>Last Review Date</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getEffectivePeriod <em>Effective Period</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getCoverage <em>Coverage</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getTopic <em>Topic</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getKeyword <em>Keyword</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getContributor <em>Contributor</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getPublisher <em>Publisher</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getSteward <em>Steward</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getRightsDeclaration <em>Rights Declaration</em>}</li> |
| * <li>{@link org.hl7.fhir.ModuleMetadata#getRelatedResource <em>Related Resource</em>}</li> |
| * </ul> |
| * |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata() |
| * @model extendedMetaData="name='ModuleMetadata' kind='elementOnly'" |
| * @generated |
| */ |
| public interface ModuleMetadata extends DomainResource { |
| /** |
| * 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 --> |
| * A logical identifier for the module such as the CMS or NQF identifiers for a measure artifact. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Identifier</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_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 version of the module, if any. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge modules, refer to the Decision Support Service specification. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Version</em>' containment reference. |
| * @see #setVersion(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_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.ModuleMetadata#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>Title</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A short, descriptive title for the module. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Title</em>' containment reference. |
| * @see #setTitle(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_Title() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='title' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getTitle(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ModuleMetadata#getTitle <em>Title</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Title</em>' containment reference. |
| * @see #getTitle() |
| * @generated |
| */ |
| void setTitle(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Type</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Identifies the type of knowledge module, such as a rule, library, documentation template, or measure. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Type</em>' containment reference. |
| * @see #setType(ModuleMetadataType) |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_Type() |
| * @model containment="true" required="true" |
| * extendedMetaData="kind='element' name='type' namespace='##targetNamespace'" |
| * @generated |
| */ |
| ModuleMetadataType getType(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ModuleMetadata#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(ModuleMetadataType 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 module. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Status</em>' containment reference. |
| * @see #setStatus(ModuleMetadataStatus) |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_Status() |
| * @model containment="true" required="true" |
| * extendedMetaData="kind='element' name='status' namespace='##targetNamespace'" |
| * @generated |
| */ |
| ModuleMetadataStatus getStatus(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ModuleMetadata#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(ModuleMetadataStatus value); |
| |
| /** |
| * Returns the value of the '<em><b>Description</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A description of the module from the consumer perspective. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Description</em>' containment reference. |
| * @see #setDescription(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_Description() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='description' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getDescription(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ModuleMetadata#getDescription <em>Description</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Description</em>' containment reference. |
| * @see #getDescription() |
| * @generated |
| */ |
| void setDescription(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Purpose</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A brief description of the purpose of the module. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Purpose</em>' containment reference. |
| * @see #setPurpose(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_Purpose() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='purpose' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getPurpose(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ModuleMetadata#getPurpose <em>Purpose</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Purpose</em>' containment reference. |
| * @see #getPurpose() |
| * @generated |
| */ |
| void setPurpose(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Usage</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Notes about usage of the module. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Usage</em>' containment reference. |
| * @see #setUsage(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_Usage() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='usage' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getUsage(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ModuleMetadata#getUsage <em>Usage</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Usage</em>' containment reference. |
| * @see #getUsage() |
| * @generated |
| */ |
| void setUsage(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Publication Date</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The date on which the module was published. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Publication Date</em>' containment reference. |
| * @see #setPublicationDate(Date) |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_PublicationDate() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='publicationDate' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Date getPublicationDate(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ModuleMetadata#getPublicationDate <em>Publication Date</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Publication Date</em>' containment reference. |
| * @see #getPublicationDate() |
| * @generated |
| */ |
| void setPublicationDate(Date value); |
| |
| /** |
| * Returns the value of the '<em><b>Last Review Date</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The date on which the module content was last reviewed. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Last Review Date</em>' containment reference. |
| * @see #setLastReviewDate(Date) |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_LastReviewDate() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='lastReviewDate' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Date getLastReviewDate(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ModuleMetadata#getLastReviewDate <em>Last Review Date</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Last Review Date</em>' containment reference. |
| * @see #getLastReviewDate() |
| * @generated |
| */ |
| void setLastReviewDate(Date value); |
| |
| /** |
| * Returns the value of the '<em><b>Effective Period</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The period during which the module content is effective. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Effective Period</em>' containment reference. |
| * @see #setEffectivePeriod(Period) |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_EffectivePeriod() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='effectivePeriod' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Period getEffectivePeriod(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ModuleMetadata#getEffectivePeriod <em>Effective Period</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Effective Period</em>' containment reference. |
| * @see #getEffectivePeriod() |
| * @generated |
| */ |
| void setEffectivePeriod(Period value); |
| |
| /** |
| * Returns the value of the '<em><b>Coverage</b></em>' containment reference list. |
| * The list contents are of type {@link org.hl7.fhir.ModuleMetadataCoverage}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Specifies various attributes of the patient population for whom and/or environment of care in which, the knowledge module is applicable. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Coverage</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_Coverage() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='coverage' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<ModuleMetadataCoverage> getCoverage(); |
| |
| /** |
| * Returns the value of the '<em><b>Topic</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 --> |
| * Clinical topics related to the content of the module. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Topic</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_Topic() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='topic' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<CodeableConcept> getTopic(); |
| |
| /** |
| * Returns the value of the '<em><b>Keyword</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 --> |
| * Keywords associated with the module. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Keyword</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_Keyword() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='keyword' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<org.hl7.fhir.String> getKeyword(); |
| |
| /** |
| * Returns the value of the '<em><b>Contributor</b></em>' containment reference list. |
| * The list contents are of type {@link org.hl7.fhir.ModuleMetadataContributor}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A contributor to the content of the module. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Contributor</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_Contributor() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='contributor' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<ModuleMetadataContributor> getContributor(); |
| |
| /** |
| * Returns the value of the '<em><b>Publisher</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The organization responsible for publishing the module. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Publisher</em>' containment reference. |
| * @see #setPublisher(Reference) |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_Publisher() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='publisher' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Reference getPublisher(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ModuleMetadata#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(Reference value); |
| |
| /** |
| * Returns the value of the '<em><b>Steward</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The organization responsible for stewardship of the module content. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Steward</em>' containment reference. |
| * @see #setSteward(Reference) |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_Steward() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='steward' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Reference getSteward(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ModuleMetadata#getSteward <em>Steward</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Steward</em>' containment reference. |
| * @see #getSteward() |
| * @generated |
| */ |
| void setSteward(Reference value); |
| |
| /** |
| * Returns the value of the '<em><b>Rights Declaration</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The legal rights declaration for the module. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Rights Declaration</em>' containment reference. |
| * @see #setRightsDeclaration(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_RightsDeclaration() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='rightsDeclaration' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getRightsDeclaration(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ModuleMetadata#getRightsDeclaration <em>Rights Declaration</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Rights Declaration</em>' containment reference. |
| * @see #getRightsDeclaration() |
| * @generated |
| */ |
| void setRightsDeclaration(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Related Resource</b></em>' containment reference list. |
| * The list contents are of type {@link org.hl7.fhir.ModuleMetadataRelatedResource}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Related resources such as additional documentation, supporting evidence, or bibliographic references. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Related Resource</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getModuleMetadata_RelatedResource() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='relatedResource' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<ModuleMetadataRelatedResource> getRelatedResource(); |
| |
| } // ModuleMetadata |
