Issue #743 - added definition to Javadoc (#753)

* Issue #743 - added definition to Javadoc

Signed-off-by: John T.E. Timm <johntimm@us.ibm.com>

* Issue #743 - reverted class annotation order per PR feedback

Signed-off-by: John T.E. Timm <johntimm@us.ibm.com>

fhir-model/src/main/java/com/ibm/fhir/model/type/code/AccountStatus.java

@@ -21,26 +21,36 @@
 public class AccountStatus extends Code {
     /**
      * Active
+     * 
+     * <p>This account is active and may be used.
      */
     public static final AccountStatus ACTIVE = AccountStatus.builder().value(ValueSet.ACTIVE).build();
 
     /**
      * Inactive
+     * 
+     * <p>This account is inactive and should not be used to track financial information.
      */
     public static final AccountStatus INACTIVE = AccountStatus.builder().value(ValueSet.INACTIVE).build();
 
     /**
      * Entered in error
+     * 
+     * <p>This instance should not have been part of this patient's medical record.
      */
     public static final AccountStatus ENTERED_IN_ERROR = AccountStatus.builder().value(ValueSet.ENTERED_IN_ERROR).build();
 
     /**
      * On Hold
+     * 
+     * <p>This account is on hold.
      */
     public static final AccountStatus ON_HOLD = AccountStatus.builder().value(ValueSet.ON_HOLD).build();
 
     /**
      * Unknown
+     * 
+     * <p>The account status is unknown.
      */
     public static final AccountStatus UNKNOWN = AccountStatus.builder().value(ValueSet.UNKNOWN).build();
 
@@ -158,26 +168,36 @@ public AccountStatus build() {
     public enum ValueSet {
         /**
          * Active
+         * 
+         * <p>This account is active and may be used.
          */
         ACTIVE("active"),
 
         /**
          * Inactive
+         * 
+         * <p>This account is inactive and should not be used to track financial information.
          */
         INACTIVE("inactive"),
 
         /**
          * Entered in error
+         * 
+         * <p>This instance should not have been part of this patient's medical record.
          */
         ENTERED_IN_ERROR("entered-in-error"),
 
         /**
          * On Hold
+         * 
+         * <p>This account is on hold.
          */
         ON_HOLD("on-hold"),
 
         /**
          * Unknown
+         * 
+         * <p>The account status is unknown.
          */
         UNKNOWN("unknown");
 

fhir-model/src/main/java/com/ibm/fhir/model/type/code/ActionCardinalityBehavior.java

@@ -21,11 +21,15 @@
 public class ActionCardinalityBehavior extends Code {
     /**
      * Single
+     * 
+     * <p>The action may only be selected one time.
      */
     public static final ActionCardinalityBehavior SINGLE = ActionCardinalityBehavior.builder().value(ValueSet.SINGLE).build();
 
     /**
      * Multiple
+     * 
+     * <p>The action may be selected multiple times.
      */
     public static final ActionCardinalityBehavior MULTIPLE = ActionCardinalityBehavior.builder().value(ValueSet.MULTIPLE).build();
 
@@ -137,11 +141,15 @@ public ActionCardinalityBehavior build() {
     public enum ValueSet {
         /**
          * Single
+         * 
+         * <p>The action may only be selected one time.
          */
         SINGLE("single"),
 
         /**
          * Multiple
+         * 
+         * <p>The action may be selected multiple times.
          */
         MULTIPLE("multiple");
 

fhir-model/src/main/java/com/ibm/fhir/model/type/code/ActionConditionKind.java

@@ -21,16 +21,22 @@
 public class ActionConditionKind extends Code {
     /**
      * Applicability
+     * 
+     * <p>The condition describes whether or not a given action is applicable.
      */
     public static final ActionConditionKind APPLICABILITY = ActionConditionKind.builder().value(ValueSet.APPLICABILITY).build();
 
     /**
      * Start
+     * 
+     * <p>The condition is a starting condition for the action.
      */
     public static final ActionConditionKind START = ActionConditionKind.builder().value(ValueSet.START).build();
 
     /**
      * Stop
+     * 
+     * <p>The condition is a stop, or exit condition for the action.
      */
     public static final ActionConditionKind STOP = ActionConditionKind.builder().value(ValueSet.STOP).build();
 
@@ -144,16 +150,22 @@ public ActionConditionKind build() {
     public enum ValueSet {
         /**
          * Applicability
+         * 
+         * <p>The condition describes whether or not a given action is applicable.
          */
         APPLICABILITY("applicability"),
 
         /**
          * Start
+         * 
+         * <p>The condition is a starting condition for the action.
          */
         START("start"),
 
         /**
          * Stop
+         * 
+         * <p>The condition is a stop, or exit condition for the action.
          */
         STOP("stop");
 

fhir-model/src/main/java/com/ibm/fhir/model/type/code/ActionGroupingBehavior.java

@@ -21,16 +21,29 @@
 public class ActionGroupingBehavior extends Code {
     /**
      * Visual Group
+     * 
+     * <p>Any group marked with this behavior should be displayed as a visual group to the end user.
      */
     public static final ActionGroupingBehavior VISUAL_GROUP = ActionGroupingBehavior.builder().value(ValueSet.VISUAL_GROUP).build();
 
     /**
      * Logical Group
+     * 
+     * <p>A group with this behavior logically groups its sub-elements, and may be shown as a visual group to the end user, 
+     * but it is not required to do so.
      */
     public static final ActionGroupingBehavior LOGICAL_GROUP = ActionGroupingBehavior.builder().value(ValueSet.LOGICAL_GROUP).build();
 
     /**
      * Sentence Group
+     * 
+     * <p>A group of related alternative actions is a sentence group if the target referenced by the action is the same in 
+     * all the actions and each action simply constitutes a different variation on how to specify the details for the target. 
+     * For example, two actions that could be in a SentenceGroup are "aspirin, 500 mg, 2 times per day" and "aspirin, 300 mg, 
+     * 3 times per day". In both cases, aspirin is the target referenced by the action, and the two actions represent 
+     * different options for how aspirin might be ordered for the patient. Note that a SentenceGroup would almost always have 
+     * an associated selection behavior of "AtMostOne", unless it's a required action, in which case, it would be 
+     * "ExactlyOne".
      */
     public static final ActionGroupingBehavior SENTENCE_GROUP = ActionGroupingBehavior.builder().value(ValueSet.SENTENCE_GROUP).build();
 
@@ -144,16 +157,29 @@ public ActionGroupingBehavior build() {
     public enum ValueSet {
         /**
          * Visual Group
+         * 
+         * <p>Any group marked with this behavior should be displayed as a visual group to the end user.
          */
         VISUAL_GROUP("visual-group"),
 
         /**
          * Logical Group
+         * 
+         * <p>A group with this behavior logically groups its sub-elements, and may be shown as a visual group to the end user, 
+         * but it is not required to do so.
          */
         LOGICAL_GROUP("logical-group"),
 
         /**
          * Sentence Group
+         * 
+         * <p>A group of related alternative actions is a sentence group if the target referenced by the action is the same in 
+         * all the actions and each action simply constitutes a different variation on how to specify the details for the target. 
+         * For example, two actions that could be in a SentenceGroup are "aspirin, 500 mg, 2 times per day" and "aspirin, 300 mg, 
+         * 3 times per day". In both cases, aspirin is the target referenced by the action, and the two actions represent 
+         * different options for how aspirin might be ordered for the patient. Note that a SentenceGroup would almost always have 
+         * an associated selection behavior of "AtMostOne", unless it's a required action, in which case, it would be 
+         * "ExactlyOne".
          */
         SENTENCE_GROUP("sentence-group");
 

fhir-model/src/main/java/com/ibm/fhir/model/type/code/ActionParticipantType.java

@@ -21,21 +21,29 @@
 public class ActionParticipantType extends Code {
     /**
      * Patient
+     * 
+     * <p>The participant is the patient under evaluation.
      */
     public static final ActionParticipantType PATIENT = ActionParticipantType.builder().value(ValueSet.PATIENT).build();
 
     /**
      * Practitioner
+     * 
+     * <p>The participant is a practitioner involved in the patient's care.
      */
     public static final ActionParticipantType PRACTITIONER = ActionParticipantType.builder().value(ValueSet.PRACTITIONER).build();
 
     /**
      * Related Person
+     * 
+     * <p>The participant is a person related to the patient.
      */
     public static final ActionParticipantType RELATED_PERSON = ActionParticipantType.builder().value(ValueSet.RELATED_PERSON).build();
 
     /**
      * Device
+     * 
+     * <p>The participant is a system or device used in the care of the patient.
      */
     public static final ActionParticipantType DEVICE = ActionParticipantType.builder().value(ValueSet.DEVICE).build();
 
@@ -151,21 +159,29 @@ public ActionParticipantType build() {
     public enum ValueSet {
         /**
          * Patient
+         * 
+         * <p>The participant is the patient under evaluation.
          */
         PATIENT("patient"),
 
         /**
          * Practitioner
+         * 
+         * <p>The participant is a practitioner involved in the patient's care.
          */
         PRACTITIONER("practitioner"),
 
         /**
          * Related Person
+         * 
+         * <p>The participant is a person related to the patient.
          */
         RELATED_PERSON("related-person"),
 
         /**
          * Device
+         * 
+         * <p>The participant is a system or device used in the care of the patient.
          */
         DEVICE("device");
 

fhir-model/src/main/java/com/ibm/fhir/model/type/code/ActionPrecheckBehavior.java

@@ -21,11 +21,19 @@
 public class ActionPrecheckBehavior extends Code {
     /**
      * Yes
+     * 
+     * <p>An action with this behavior is one of the most frequent action that is, or should be, included by an end user, for 
+     * the particular context in which the action occurs. The system displaying the action to the end user should consider 
+     * "pre-checking" such an action as a convenience for the user.
      */
     public static final ActionPrecheckBehavior YES = ActionPrecheckBehavior.builder().value(ValueSet.YES).build();
 
     /**
      * No
+     * 
+     * <p>An action with this behavior is one of the less frequent actions included by the end user, for the particular 
+     * context in which the action occurs. The system displaying the actions to the end user would typically not "pre-check" 
+     * such an action.
      */
     public static final ActionPrecheckBehavior NO = ActionPrecheckBehavior.builder().value(ValueSet.NO).build();
 
@@ -137,11 +145,19 @@ public ActionPrecheckBehavior build() {
     public enum ValueSet {
         /**
          * Yes
+         * 
+         * <p>An action with this behavior is one of the most frequent action that is, or should be, included by an end user, for 
+         * the particular context in which the action occurs. The system displaying the action to the end user should consider 
+         * "pre-checking" such an action as a convenience for the user.
          */
         YES("yes"),
 
         /**
          * No
+         * 
+         * <p>An action with this behavior is one of the less frequent actions included by the end user, for the particular 
+         * context in which the action occurs. The system displaying the actions to the end user would typically not "pre-check" 
+         * such an action.
          */
         NO("no");