| /** |
| */ |
| package org.hl7.fhir; |
| |
| import org.eclipse.emf.common.util.EList; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Value Set</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html). |
| * 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.ValueSet#getUrl <em>Url</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getIdentifier <em>Identifier</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getVersion <em>Version</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getName <em>Name</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getTitle <em>Title</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getStatus <em>Status</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getExperimental <em>Experimental</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getDate <em>Date</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getPublisher <em>Publisher</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getContact <em>Contact</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getDescription <em>Description</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getUseContext <em>Use Context</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getJurisdiction <em>Jurisdiction</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getImmutable <em>Immutable</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getPurpose <em>Purpose</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getCopyright <em>Copyright</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getCompose <em>Compose</em>}</li> |
| * <li>{@link org.hl7.fhir.ValueSet#getExpansion <em>Expansion</em>}</li> |
| * </ul> |
| * |
| * @see org.hl7.fhir.FhirPackage#getValueSet() |
| * @model extendedMetaData="name='ValueSet' kind='elementOnly'" |
| * @generated |
| */ |
| public interface ValueSet 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 URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Url</em>' containment reference. |
| * @see #setUrl(Uri) |
| * @see org.hl7.fhir.FhirPackage#getValueSet_Url() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='url' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Uri getUrl(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ValueSet#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 --> |
| * A formal identifier that is used to identify this value set 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#getValueSet_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 value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Version</em>' containment reference. |
| * @see #setVersion(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getValueSet_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.ValueSet#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 --> |
| * A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Name</em>' containment reference. |
| * @see #setName(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getValueSet_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.ValueSet#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>Title</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A short, descriptive, user-friendly title for the value set. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Title</em>' containment reference. |
| * @see #setTitle(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getValueSet_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.ValueSet#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>Status</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Status</em>' containment reference. |
| * @see #setStatus(PublicationStatus) |
| * @see org.hl7.fhir.FhirPackage#getValueSet_Status() |
| * @model containment="true" required="true" |
| * extendedMetaData="kind='element' name='status' namespace='##targetNamespace'" |
| * @generated |
| */ |
| PublicationStatus getStatus(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ValueSet#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(PublicationStatus value); |
| |
| /** |
| * Returns the value of the '<em><b>Experimental</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A Boolean value to indicate that this value set 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#getValueSet_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.ValueSet#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>Date</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition'). |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Date</em>' containment reference. |
| * @see #setDate(DateTime) |
| * @see org.hl7.fhir.FhirPackage#getValueSet_Date() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='date' namespace='##targetNamespace'" |
| * @generated |
| */ |
| DateTime getDate(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ValueSet#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>Publisher</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The name of the organization or individual that published the value set. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Publisher</em>' containment reference. |
| * @see #setPublisher(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getValueSet_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.ValueSet#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.ContactDetail}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Contact details 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#getValueSet_Contact() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='contact' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<ContactDetail> getContact(); |
| |
| /** |
| * Returns the value of the '<em><b>Description</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Description</em>' containment reference. |
| * @see #setDescription(Markdown) |
| * @see org.hl7.fhir.FhirPackage#getValueSet_Description() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='description' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Markdown getDescription(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ValueSet#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(Markdown 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.UsageContext}. |
| * <!-- 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 contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Use Context</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getValueSet_UseContext() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='useContext' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<UsageContext> getUseContext(); |
| |
| /** |
| * Returns the value of the '<em><b>Jurisdiction</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 --> |
| * A legal or geographic region in which the value set is intended to be used. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Jurisdiction</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getValueSet_Jurisdiction() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='jurisdiction' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<CodeableConcept> getJurisdiction(); |
| |
| /** |
| * Returns the value of the '<em><b>Immutable</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Immutable</em>' containment reference. |
| * @see #setImmutable(org.hl7.fhir.Boolean) |
| * @see org.hl7.fhir.FhirPackage#getValueSet_Immutable() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='immutable' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.Boolean getImmutable(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ValueSet#getImmutable <em>Immutable</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Immutable</em>' containment reference. |
| * @see #getImmutable() |
| * @generated |
| */ |
| void setImmutable(org.hl7.fhir.Boolean value); |
| |
| /** |
| * Returns the value of the '<em><b>Purpose</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Explanation of why this value set is needed and why it has been designed as it has. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Purpose</em>' containment reference. |
| * @see #setPurpose(Markdown) |
| * @see org.hl7.fhir.FhirPackage#getValueSet_Purpose() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='purpose' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Markdown getPurpose(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ValueSet#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(Markdown value); |
| |
| /** |
| * 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 value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Copyright</em>' containment reference. |
| * @see #setCopyright(Markdown) |
| * @see org.hl7.fhir.FhirPackage#getValueSet_Copyright() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='copyright' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Markdown getCopyright(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ValueSet#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(Markdown value); |
| |
| /** |
| * Returns the value of the '<em><b>Compose</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD). |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Compose</em>' containment reference. |
| * @see #setCompose(ValueSetCompose) |
| * @see org.hl7.fhir.FhirPackage#getValueSet_Compose() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='compose' namespace='##targetNamespace'" |
| * @generated |
| */ |
| ValueSetCompose getCompose(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ValueSet#getCompose <em>Compose</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Compose</em>' containment reference. |
| * @see #getCompose() |
| * @generated |
| */ |
| void setCompose(ValueSetCompose value); |
| |
| /** |
| * Returns the value of the '<em><b>Expansion</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Expansion</em>' containment reference. |
| * @see #setExpansion(ValueSetExpansion) |
| * @see org.hl7.fhir.FhirPackage#getValueSet_Expansion() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='expansion' namespace='##targetNamespace'" |
| * @generated |
| */ |
| ValueSetExpansion getExpansion(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ValueSet#getExpansion <em>Expansion</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Expansion</em>' containment reference. |
| * @see #getExpansion() |
| * @generated |
| */ |
| void setExpansion(ValueSetExpansion value); |
| |
| } // ValueSet |
