blob: 8bdac218b65083759794e08532926dd4a454675c [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2015 David A Carlson.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* David A Carlson (Clinical Cloud Solutions, LLC) - initial API and implementation
*******************************************************************************/
/**
*/
package org.hl7.fhir;
import org.eclipse.emf.common.util.EList;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Questionnaire Group</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* A structured set of questions intended to guide the collection of answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.hl7.fhir.QuestionnaireGroup#getLinkId <em>Link Id</em>}</li>
* <li>{@link org.hl7.fhir.QuestionnaireGroup#getTitle <em>Title</em>}</li>
* <li>{@link org.hl7.fhir.QuestionnaireGroup#getConcept <em>Concept</em>}</li>
* <li>{@link org.hl7.fhir.QuestionnaireGroup#getText <em>Text</em>}</li>
* <li>{@link org.hl7.fhir.QuestionnaireGroup#getRequired <em>Required</em>}</li>
* <li>{@link org.hl7.fhir.QuestionnaireGroup#getRepeats <em>Repeats</em>}</li>
* <li>{@link org.hl7.fhir.QuestionnaireGroup#getGroup <em>Group</em>}</li>
* <li>{@link org.hl7.fhir.QuestionnaireGroup#getQuestion <em>Question</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getQuestionnaireGroup()
* @model extendedMetaData="name='Questionnaire.Group' kind='elementOnly'"
* @generated
*/
public interface QuestionnaireGroup extends BackboneElement {
/**
* Returns the value of the '<em><b>Link Id</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* An identifier that is unique within the Questionnaire allowing linkage to the equivalent group in a QuestionnaireResponse resource.
* <!-- end-model-doc -->
* @return the value of the '<em>Link Id</em>' containment reference.
* @see #setLinkId(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getQuestionnaireGroup_LinkId()
* @model containment="true"
* extendedMetaData="kind='element' name='linkId' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getLinkId();
/**
* Sets the value of the '{@link org.hl7.fhir.QuestionnaireGroup#getLinkId <em>Link Id</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Link Id</em>' containment reference.
* @see #getLinkId()
* @generated
*/
void setLinkId(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 -->
* The human-readable name for this section of the questionnaire.
* <!-- end-model-doc -->
* @return the value of the '<em>Title</em>' containment reference.
* @see #setTitle(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getQuestionnaireGroup_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.QuestionnaireGroup#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>Concept</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Coding}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Identifies a how this group of questions is known in a particular terminology such as LOINC.
* <!-- end-model-doc -->
* @return the value of the '<em>Concept</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getQuestionnaireGroup_Concept()
* @model containment="true"
* extendedMetaData="kind='element' name='concept' namespace='##targetNamespace'"
* @generated
*/
EList<Coding> getConcept();
/**
* Returns the value of the '<em><b>Text</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Additional text for the group, used for display purposes.
* <!-- end-model-doc -->
* @return the value of the '<em>Text</em>' containment reference.
* @see #setText(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getQuestionnaireGroup_Text()
* @model containment="true"
* extendedMetaData="kind='element' name='text' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getText();
/**
* Sets the value of the '{@link org.hl7.fhir.QuestionnaireGroup#getText <em>Text</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Text</em>' containment reference.
* @see #getText()
* @generated
*/
void setText(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Required</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* If true, indicates that the group must be present and have required questions within it answered. If false, the group may be skipped when answering the questionnaire.
* <!-- end-model-doc -->
* @return the value of the '<em>Required</em>' containment reference.
* @see #setRequired(org.hl7.fhir.Boolean)
* @see org.hl7.fhir.FhirPackage#getQuestionnaireGroup_Required()
* @model containment="true"
* extendedMetaData="kind='element' name='required' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.Boolean getRequired();
/**
* Sets the value of the '{@link org.hl7.fhir.QuestionnaireGroup#getRequired <em>Required</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Required</em>' containment reference.
* @see #getRequired()
* @generated
*/
void setRequired(org.hl7.fhir.Boolean value);
/**
* Returns the value of the '<em><b>Repeats</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Whether the group may occur multiple times in the instance, containing multiple sets of answers.
* <!-- end-model-doc -->
* @return the value of the '<em>Repeats</em>' containment reference.
* @see #setRepeats(org.hl7.fhir.Boolean)
* @see org.hl7.fhir.FhirPackage#getQuestionnaireGroup_Repeats()
* @model containment="true"
* extendedMetaData="kind='element' name='repeats' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.Boolean getRepeats();
/**
* Sets the value of the '{@link org.hl7.fhir.QuestionnaireGroup#getRepeats <em>Repeats</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Repeats</em>' containment reference.
* @see #getRepeats()
* @generated
*/
void setRepeats(org.hl7.fhir.Boolean value);
/**
* Returns the value of the '<em><b>Group</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.QuestionnaireGroup}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A sub-group within a group. The ordering of groups within this group is relevant.
* <!-- end-model-doc -->
* @return the value of the '<em>Group</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getQuestionnaireGroup_Group()
* @model containment="true"
* extendedMetaData="kind='element' name='group' namespace='##targetNamespace'"
* @generated
*/
EList<QuestionnaireGroup> getGroup();
/**
* Returns the value of the '<em><b>Question</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.QuestionnaireQuestion}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Set of questions within this group. The order of questions within the group is relevant.
* <!-- end-model-doc -->
* @return the value of the '<em>Question</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getQuestionnaireGroup_Question()
* @model containment="true"
* extendedMetaData="kind='element' name='question' namespace='##targetNamespace'"
* @generated
*/
EList<QuestionnaireQuestion> getQuestion();
} // QuestionnaireGroup