From b3cf323e07fae33b16902cd72088e42b295b221c Mon Sep 17 00:00:00 2001
From: jamesagnew <jamesagnew@gmail.com>
Date: Fri, 20 Mar 2020 18:30:14 -0400
Subject: [PATCH] Add docs

---
 .../main/java/ca/uhn/fhir/rest/param/ReferenceParam.java   | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/param/ReferenceParam.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/param/ReferenceParam.java
index 6f9e3babc32..7e59d6d08eb 100644
--- a/hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/param/ReferenceParam.java
+++ b/hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/param/ReferenceParam.java
@@ -200,6 +200,13 @@ public class ReferenceParam extends BaseParam /*implements IQueryParameterType*/
 		return myValue;
 	}
 
+	/**
+	 * Note that the parameter to this method <b>must</b> be a resource reference, e.g
+	 * <code>123</code> or <code>Patient/123</code> or <code>http://example.com/fhir/Patient/123</code>
+	 * or something like this. This is not appropriate for cases where a chain is being used and
+	 * the value is for a different type of parameter (e.g. a token). In that case, use one of the
+	 * setter constructors.
+	 */
 	public ReferenceParam setValue(String theValue) {
 		IdDt id = new IdDt(theValue);
 		String qualifier= null;