| /** |
| */ |
| package org.hl7.fhir; |
| |
| import org.eclipse.emf.common.util.EList; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Concept Map</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models. |
| * 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.ConceptMap#getUrl <em>Url</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getIdentifier <em>Identifier</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getVersion <em>Version</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getName <em>Name</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getTitle <em>Title</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getStatus <em>Status</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getExperimental <em>Experimental</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getDate <em>Date</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getPublisher <em>Publisher</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getContact <em>Contact</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getDescription <em>Description</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getUseContext <em>Use Context</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getJurisdiction <em>Jurisdiction</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getPurpose <em>Purpose</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getCopyright <em>Copyright</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getSourceUri <em>Source Uri</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getSourceCanonical <em>Source Canonical</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getTargetUri <em>Target Uri</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getTargetCanonical <em>Target Canonical</em>}</li> |
| * <li>{@link org.hl7.fhir.ConceptMap#getGroup <em>Group</em>}</li> |
| * </ul> |
| * |
| * @see org.hl7.fhir.FhirPackage#getConceptMap() |
| * @model extendedMetaData="name='ConceptMap' kind='elementOnly'" |
| * @generated |
| */ |
| public interface ConceptMap 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 concept map 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 concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map 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#getConceptMap_Url() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='url' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Uri getUrl(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ConceptMap#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. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A formal identifier that is used to identify this concept map 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. |
| * @see #setIdentifier(Identifier) |
| * @see org.hl7.fhir.FhirPackage#getConceptMap_Identifier() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='identifier' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Identifier getIdentifier(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ConceptMap#getIdentifier <em>Identifier</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Identifier</em>' containment reference. |
| * @see #getIdentifier() |
| * @generated |
| */ |
| void setIdentifier(Identifier value); |
| |
| /** |
| * 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 concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map 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#getConceptMap_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.ConceptMap#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 concept map. 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#getConceptMap_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.ConceptMap#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 concept map. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Title</em>' containment reference. |
| * @see #setTitle(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getConceptMap_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.ConceptMap#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 concept map. Enables tracking the life-cycle of the content. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Status</em>' containment reference. |
| * @see #setStatus(PublicationStatus) |
| * @see org.hl7.fhir.FhirPackage#getConceptMap_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.ConceptMap#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 concept map 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#getConceptMap_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.ConceptMap#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 concept map was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Date</em>' containment reference. |
| * @see #setDate(DateTime) |
| * @see org.hl7.fhir.FhirPackage#getConceptMap_Date() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='date' namespace='##targetNamespace'" |
| * @generated |
| */ |
| DateTime getDate(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ConceptMap#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 concept map. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Publisher</em>' containment reference. |
| * @see #setPublisher(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getConceptMap_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.ConceptMap#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#getConceptMap_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 concept map from a consumer's perspective. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Description</em>' containment reference. |
| * @see #setDescription(Markdown) |
| * @see org.hl7.fhir.FhirPackage#getConceptMap_Description() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='description' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Markdown getDescription(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ConceptMap#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 concept map instances. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Use Context</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getConceptMap_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 concept map is intended to be used. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Jurisdiction</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getConceptMap_Jurisdiction() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='jurisdiction' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<CodeableConcept> getJurisdiction(); |
| |
| /** |
| * 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 concept map 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#getConceptMap_Purpose() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='purpose' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Markdown getPurpose(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ConceptMap#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 concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Copyright</em>' containment reference. |
| * @see #setCopyright(Markdown) |
| * @see org.hl7.fhir.FhirPackage#getConceptMap_Copyright() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='copyright' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Markdown getCopyright(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ConceptMap#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>Source Uri</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Source Uri</em>' containment reference isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * @return the value of the '<em>Source Uri</em>' containment reference. |
| * @see #setSourceUri(Uri) |
| * @see org.hl7.fhir.FhirPackage#getConceptMap_SourceUri() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='sourceUri' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Uri getSourceUri(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ConceptMap#getSourceUri <em>Source Uri</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Source Uri</em>' containment reference. |
| * @see #getSourceUri() |
| * @generated |
| */ |
| void setSourceUri(Uri value); |
| |
| /** |
| * Returns the value of the '<em><b>Source Canonical</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Source Canonical</em>' containment reference isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * @return the value of the '<em>Source Canonical</em>' containment reference. |
| * @see #setSourceCanonical(Canonical) |
| * @see org.hl7.fhir.FhirPackage#getConceptMap_SourceCanonical() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='sourceCanonical' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Canonical getSourceCanonical(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ConceptMap#getSourceCanonical <em>Source Canonical</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Source Canonical</em>' containment reference. |
| * @see #getSourceCanonical() |
| * @generated |
| */ |
| void setSourceCanonical(Canonical value); |
| |
| /** |
| * Returns the value of the '<em><b>Target Uri</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Target Uri</em>' containment reference isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * @return the value of the '<em>Target Uri</em>' containment reference. |
| * @see #setTargetUri(Uri) |
| * @see org.hl7.fhir.FhirPackage#getConceptMap_TargetUri() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='targetUri' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Uri getTargetUri(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ConceptMap#getTargetUri <em>Target Uri</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Target Uri</em>' containment reference. |
| * @see #getTargetUri() |
| * @generated |
| */ |
| void setTargetUri(Uri value); |
| |
| /** |
| * Returns the value of the '<em><b>Target Canonical</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Target Canonical</em>' containment reference isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * @return the value of the '<em>Target Canonical</em>' containment reference. |
| * @see #setTargetCanonical(Canonical) |
| * @see org.hl7.fhir.FhirPackage#getConceptMap_TargetCanonical() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='targetCanonical' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Canonical getTargetCanonical(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.ConceptMap#getTargetCanonical <em>Target Canonical</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Target Canonical</em>' containment reference. |
| * @see #getTargetCanonical() |
| * @generated |
| */ |
| void setTargetCanonical(Canonical value); |
| |
| /** |
| * Returns the value of the '<em><b>Group</b></em>' containment reference list. |
| * The list contents are of type {@link org.hl7.fhir.ConceptMapGroup}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A group of mappings that all have the same source and target system. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Group</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getConceptMap_Group() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='group' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<ConceptMapGroup> getGroup(); |
| |
| } // ConceptMap |
