| /** |
| */ |
| package org.hl7.fhir; |
| |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Related Artifact</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * Related artifacts such as additional documentation, justification, or bibliographic references. |
| * 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.RelatedArtifact#getType <em>Type</em>}</li> |
| * <li>{@link org.hl7.fhir.RelatedArtifact#getLabel <em>Label</em>}</li> |
| * <li>{@link org.hl7.fhir.RelatedArtifact#getDisplay <em>Display</em>}</li> |
| * <li>{@link org.hl7.fhir.RelatedArtifact#getCitation <em>Citation</em>}</li> |
| * <li>{@link org.hl7.fhir.RelatedArtifact#getUrl <em>Url</em>}</li> |
| * <li>{@link org.hl7.fhir.RelatedArtifact#getDocument <em>Document</em>}</li> |
| * <li>{@link org.hl7.fhir.RelatedArtifact#getResource <em>Resource</em>}</li> |
| * </ul> |
| * |
| * @see org.hl7.fhir.FhirPackage#getRelatedArtifact() |
| * @model extendedMetaData="name='RelatedArtifact' kind='elementOnly'" |
| * @generated |
| */ |
| public interface RelatedArtifact extends Element { |
| /** |
| * Returns the value of the '<em><b>Type</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The type of relationship to the related artifact. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Type</em>' containment reference. |
| * @see #setType(RelatedArtifactType) |
| * @see org.hl7.fhir.FhirPackage#getRelatedArtifact_Type() |
| * @model containment="true" required="true" |
| * extendedMetaData="kind='element' name='type' namespace='##targetNamespace'" |
| * @generated |
| */ |
| RelatedArtifactType getType(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.RelatedArtifact#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(RelatedArtifactType value); |
| |
| /** |
| * Returns the value of the '<em><b>Label</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Label</em>' containment reference. |
| * @see #setLabel(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getRelatedArtifact_Label() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='label' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getLabel(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.RelatedArtifact#getLabel <em>Label</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Label</em>' containment reference. |
| * @see #getLabel() |
| * @generated |
| */ |
| void setLabel(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Display</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A brief description of the document or knowledge resource being referenced, suitable for display to a consumer. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Display</em>' containment reference. |
| * @see #setDisplay(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getRelatedArtifact_Display() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='display' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getDisplay(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.RelatedArtifact#getDisplay <em>Display</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Display</em>' containment reference. |
| * @see #getDisplay() |
| * @generated |
| */ |
| void setDisplay(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Citation</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Citation</em>' containment reference. |
| * @see #setCitation(Markdown) |
| * @see org.hl7.fhir.FhirPackage#getRelatedArtifact_Citation() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='citation' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Markdown getCitation(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.RelatedArtifact#getCitation <em>Citation</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Citation</em>' containment reference. |
| * @see #getCitation() |
| * @generated |
| */ |
| void setCitation(Markdown value); |
| |
| /** |
| * Returns the value of the '<em><b>Url</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A url for the artifact that can be followed to access the actual content. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Url</em>' containment reference. |
| * @see #setUrl(Url) |
| * @see org.hl7.fhir.FhirPackage#getRelatedArtifact_Url() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='url' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Url getUrl(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.RelatedArtifact#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(Url value); |
| |
| /** |
| * Returns the value of the '<em><b>Document</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The document being referenced, represented as an attachment. This is exclusive with the resource element. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Document</em>' containment reference. |
| * @see #setDocument(Attachment) |
| * @see org.hl7.fhir.FhirPackage#getRelatedArtifact_Document() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='document' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Attachment getDocument(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.RelatedArtifact#getDocument <em>Document</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Document</em>' containment reference. |
| * @see #getDocument() |
| * @generated |
| */ |
| void setDocument(Attachment value); |
| |
| /** |
| * Returns the value of the '<em><b>Resource</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The related resource, such as a library, value set, profile, or other knowledge resource. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Resource</em>' containment reference. |
| * @see #setResource(Canonical) |
| * @see org.hl7.fhir.FhirPackage#getRelatedArtifact_Resource() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='resource' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Canonical getResource(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.RelatedArtifact#getResource <em>Resource</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Resource</em>' containment reference. |
| * @see #getResource() |
| * @generated |
| */ |
| void setResource(Canonical value); |
| |
| } // RelatedArtifact |
