Package org.hl7.fhir.r5.model

Class DocumentReference

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.DocumentReference

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class DocumentReference
extends DomainResource

A reference to a document of any kind for any purpose. While the term ?document? implies a more narrow focus, for this resource this ?document? encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentReference.DocumentReferenceAttesterComponent
static class	DocumentReference.DocumentReferenceContentComponent
static class	DocumentReference.DocumentReferenceContentProfileComponent
static class	DocumentReference.DocumentReferenceRelatesToComponent
static enum	DocumentReference.DocumentReferenceStatus
static class	DocumentReference.DocumentReferenceStatusEnumFactory

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<DocumentReference.DocumentReferenceAttesterComponent>	attester	A participant who has authenticated the accuracy of the document.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ATTESTER	Fluent Client search parameter constant for attester
protected List<Reference>	author	Identifies who is responsible for adding the information to the document.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	AUTHOR	Fluent Client search parameter constant for author
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	BASED_ON	Fluent Client search parameter constant for based-on
protected List<Reference>	basedOn	A procedure that is fulfilled in whole or in part by the creation of this media.
protected List<CodeableReference>	bodySite	The anatomic structures included in the document.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	BODYSITE	Fluent Client search parameter constant for bodysite
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	BODYSITE_REFERENCE	Fluent Client search parameter constant for bodysite-reference
protected List<CodeableConcept>	category	A categorization for the type of document referenced - helps for indexing and searching.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CATEGORY	Fluent Client search parameter constant for category
protected List<DocumentReference.DocumentReferenceContentComponent>	content	The document and format referenced.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTENTTYPE	Fluent Client search parameter constant for contenttype
protected List<Reference>	context	Describes the clinical encounter or type of care that the document content is associated with.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CONTEXT	Fluent Client search parameter constant for context
static final ca.uhn.fhir.rest.gclient.DateClientParam	CREATION	Fluent Client search parameter constant for creation
protected Reference	custodian	Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CUSTODIAN	Fluent Client search parameter constant for custodian
protected InstantType	date	When the document reference was created.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
protected MarkdownType	description	Human-readable description of the source document.
static final ca.uhn.fhir.rest.gclient.StringClientParam	DESCRIPTION	Fluent Client search parameter constant for description
static final ca.uhn.fhir.rest.gclient.TokenClientParam	DOC_STATUS	Fluent Client search parameter constant for doc-status
protected Enumeration<Enumerations.CompositionStatus>	docStatus	The status of the underlying document.
protected List<CodeableReference>	event	This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	EVENT_CODE	Fluent Client search parameter constant for event-code
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	EVENT_REFERENCE	Fluent Client search parameter constant for event-reference
static final ca.uhn.fhir.rest.gclient.TokenClientParam	FACILITY	Fluent Client search parameter constant for facility
protected CodeableConcept	facilityType	The kind of facility where the patient was seen.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	FORMAT_CANONICAL	Fluent Client search parameter constant for format-canonical
static final ca.uhn.fhir.rest.gclient.TokenClientParam	FORMAT_CODE	Fluent Client search parameter constant for format-code
static final ca.uhn.fhir.rest.gclient.UriClientParam	FORMAT_URI	Fluent Client search parameter constant for format-uri
protected List<Identifier>	identifier	Other business identifiers associated with the document, including version independent identifiers.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_ATTESTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_AUTHOR	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_BASED_ON	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_BODYSITE_REFERENCE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_CONTEXT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_CUSTODIAN	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_EVENT_REFERENCE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_FORMAT_CANONICAL	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_RELATESTO	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBJECT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	LANGUAGE	Fluent Client search parameter constant for language
static final ca.uhn.fhir.rest.gclient.UriClientParam	LOCATION	Fluent Client search parameter constant for location
protected List<CodeableConcept>	modality	Imaging modality used.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	MODALITY	Fluent Client search parameter constant for modality
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected Period	period	The time period over which the service that is described by the document was provided.
static final ca.uhn.fhir.rest.gclient.DateClientParam	PERIOD	Fluent Client search parameter constant for period
protected CodeableConcept	practiceSetting	This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
protected List<DocumentReference.DocumentReferenceRelatesToComponent>	relatesTo	Relationships that this document has with other document references that already exist.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	RELATESTO	Fluent Client search parameter constant for relatesto
static final ca.uhn.fhir.rest.gclient.TokenClientParam	RELATION	Fluent Client search parameter constant for relation
static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.ReferenceClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>	RELATIONSHIP	Fluent Client search parameter constant for relationship
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SECURITY_LABEL	Fluent Client search parameter constant for security-label
protected List<CodeableConcept>	securityLabel	A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SETTING	Fluent Client search parameter constant for setting
static final String	SP_ATTESTER	Search parameter: attester
static final String	SP_AUTHOR	Search parameter: author
static final String	SP_BASED_ON	Search parameter: based-on
static final String	SP_BODYSITE	Search parameter: bodysite
static final String	SP_BODYSITE_REFERENCE	Search parameter: bodysite-reference
static final String	SP_CATEGORY	Search parameter: category
static final String	SP_CONTENTTYPE	Search parameter: contenttype
static final String	SP_CONTEXT	Search parameter: context
static final String	SP_CREATION	Search parameter: creation
static final String	SP_CUSTODIAN	Search parameter: custodian
static final String	SP_DATE	Search parameter: date
static final String	SP_DESCRIPTION	Search parameter: description
static final String	SP_DOC_STATUS	Search parameter: doc-status
static final String	SP_EVENT_CODE	Search parameter: event-code
static final String	SP_EVENT_REFERENCE	Search parameter: event-reference
static final String	SP_FACILITY	Search parameter: facility
static final String	SP_FORMAT_CANONICAL	Search parameter: format-canonical
static final String	SP_FORMAT_CODE	Search parameter: format-code
static final String	SP_FORMAT_URI	Search parameter: format-uri
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_LANGUAGE	Search parameter: language
static final String	SP_LOCATION	Search parameter: location
static final String	SP_MODALITY	Search parameter: modality
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_PERIOD	Search parameter: period
static final String	SP_RELATESTO	Search parameter: relatesto
static final String	SP_RELATION	Search parameter: relation
static final String	SP_RELATIONSHIP	Search parameter: relationship
static final String	SP_SECURITY_LABEL	Search parameter: security-label
static final String	SP_SETTING	Search parameter: setting
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUBJECT	Search parameter: subject
static final String	SP_TYPE	Search parameter: type
static final String	SP_VERSION	Search parameter: version
protected Enumeration<DocumentReference.DocumentReferenceStatus>	status	The status of this document reference.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Reference	subject	Who or what the document is about.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
protected CodeableConcept	type	Specifies the particular kind of document referenced (e.g.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type
protected StringType	version	An explicitly assigned identifer of a variation of the content in the DocumentReference.
static final ca.uhn.fhir.rest.gclient.StringClientParam	VERSION	Fluent Client search parameter constant for version

Fields inherited from class org.hl7.fhir.r5.model.DomainResource

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
DocumentReference()	Constructor
DocumentReference(DocumentReference.DocumentReferenceStatus status, DocumentReference.DocumentReferenceContentComponent content)	Constructor

Method Summary

Modifier and Type	Method	Description
DocumentReference.DocumentReferenceAttesterComponent	addAttester()
DocumentReference	addAttester(DocumentReference.DocumentReferenceAttesterComponent t)
Reference	addAuthor()
DocumentReference	addAuthor(Reference t)
Reference	addBasedOn()
DocumentReference	addBasedOn(Reference t)
CodeableReference	addBodySite()
DocumentReference	addBodySite(CodeableReference t)
CodeableConcept	addCategory()
DocumentReference	addCategory(CodeableConcept t)
Base	addChild(String name)
DocumentReference.DocumentReferenceContentComponent	addContent()
DocumentReference	addContent(DocumentReference.DocumentReferenceContentComponent t)
Reference	addContext()
DocumentReference	addContext(Reference t)
CodeableReference	addEvent()
DocumentReference	addEvent(CodeableReference t)
Identifier	addIdentifier()
DocumentReference	addIdentifier(Identifier t)
CodeableConcept	addModality()
DocumentReference	addModality(CodeableConcept t)
DocumentReference.DocumentReferenceRelatesToComponent	addRelatesTo()
DocumentReference	addRelatesTo(DocumentReference.DocumentReferenceRelatesToComponent t)
CodeableConcept	addSecurityLabel()
DocumentReference	addSecurityLabel(CodeableConcept t)
DocumentReference	copy()
void	copyValues(DocumentReference dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<DocumentReference.DocumentReferenceAttesterComponent>	getAttester()
DocumentReference.DocumentReferenceAttesterComponent	getAttesterFirstRep()
List<Reference>	getAuthor()
Reference	getAuthorFirstRep()
List<Reference>	getBasedOn()
Reference	getBasedOnFirstRep()
List<CodeableReference>	getBodySite()
CodeableReference	getBodySiteFirstRep()
List<CodeableConcept>	getCategory()
CodeableConcept	getCategoryFirstRep()
List<DocumentReference.DocumentReferenceContentComponent>	getContent()
DocumentReference.DocumentReferenceContentComponent	getContentFirstRep()
List<Reference>	getContext()
Reference	getContextFirstRep()
Reference	getCustodian()
Date	getDate()
InstantType	getDateElement()
String	getDescription()
MarkdownType	getDescriptionElement()
Enumerations.CompositionStatus	getDocStatus()
Enumeration<Enumerations.CompositionStatus>	getDocStatusElement()
List<CodeableReference>	getEvent()
CodeableReference	getEventFirstRep()
CodeableConcept	getFacilityType()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CodeableConcept>	getModality()
CodeableConcept	getModalityFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Period	getPeriod()
CodeableConcept	getPracticeSetting()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<DocumentReference.DocumentReferenceRelatesToComponent>	getRelatesTo()
DocumentReference.DocumentReferenceRelatesToComponent	getRelatesToFirstRep()
ResourceType	getResourceType()
List<CodeableConcept>	getSecurityLabel()
CodeableConcept	getSecurityLabelFirstRep()
DocumentReference.DocumentReferenceStatus	getStatus()
Enumeration<DocumentReference.DocumentReferenceStatus>	getStatusElement()
Reference	getSubject()
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
String	getVersion()
StringType	getVersionElement()
boolean	hasAttester()
boolean	hasAuthor()
boolean	hasBasedOn()
boolean	hasBodySite()
boolean	hasCategory()
boolean	hasContent()
boolean	hasContext()
boolean	hasCustodian()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasDocStatus()
boolean	hasDocStatusElement()
boolean	hasEvent()
boolean	hasFacilityType()
boolean	hasIdentifier()
boolean	hasModality()
boolean	hasPeriod()
boolean	hasPracticeSetting()
boolean	hasRelatesTo()
boolean	hasSecurityLabel()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasType()
boolean	hasVersion()
boolean	hasVersionElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
DocumentReference	setAttester(List<DocumentReference.DocumentReferenceAttesterComponent> theAttester)
DocumentReference	setAuthor(List<Reference> theAuthor)
DocumentReference	setBasedOn(List<Reference> theBasedOn)
DocumentReference	setBodySite(List<CodeableReference> theBodySite)
DocumentReference	setCategory(List<CodeableConcept> theCategory)
DocumentReference	setContent(List<DocumentReference.DocumentReferenceContentComponent> theContent)
DocumentReference	setContext(List<Reference> theContext)
DocumentReference	setCustodian(Reference value)
DocumentReference	setDate(Date value)
DocumentReference	setDateElement(InstantType value)
DocumentReference	setDescription(String value)
DocumentReference	setDescriptionElement(MarkdownType value)
DocumentReference	setDocStatus(Enumerations.CompositionStatus value)
DocumentReference	setDocStatusElement(Enumeration<Enumerations.CompositionStatus> value)
DocumentReference	setEvent(List<CodeableReference> theEvent)
DocumentReference	setFacilityType(CodeableConcept value)
DocumentReference	setIdentifier(List<Identifier> theIdentifier)
DocumentReference	setModality(List<CodeableConcept> theModality)
DocumentReference	setPeriod(Period value)
DocumentReference	setPracticeSetting(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
DocumentReference	setRelatesTo(List<DocumentReference.DocumentReferenceRelatesToComponent> theRelatesTo)
DocumentReference	setSecurityLabel(List<CodeableConcept> theSecurityLabel)
DocumentReference	setStatus(DocumentReference.DocumentReferenceStatus value)
DocumentReference	setStatusElement(Enumeration<DocumentReference.DocumentReferenceStatus> value)
DocumentReference	setSubject(Reference value)
DocumentReference	setType(CodeableConcept value)
DocumentReference	setVersion(String value)
DocumentReference	setVersionElement(StringType value)
protected DocumentReference	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, removeChild, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

Other business identifiers associated with the document, including version independent identifiers.

version

protected StringType version

An explicitly assigned identifer of a variation of the content in the DocumentReference.

basedOn

protected List<Reference> basedOn

A procedure that is fulfilled in whole or in part by the creation of this media.

status

protected Enumeration<DocumentReference.DocumentReferenceStatus> status

The status of this document reference.

docStatus

protected Enumeration<Enumerations.CompositionStatus> docStatus

The status of the underlying document.

modality

protected List<CodeableConcept> modality

Imaging modality used. This may include both acquisition and non-acquisition modalities.

type

protected CodeableConcept type

Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

category

protected List<CodeableConcept> category

A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

subject

protected Reference subject

Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

context

protected List<Reference> context

Describes the clinical encounter or type of care that the document content is associated with.

event

protected List<CodeableReference> event

This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

bodySite

protected List<CodeableReference> bodySite

The anatomic structures included in the document.

facilityType

protected CodeableConcept facilityType

The kind of facility where the patient was seen.

practiceSetting

protected CodeableConcept practiceSetting

This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

period

protected Period period

The time period over which the service that is described by the document was provided.

date

protected InstantType date

When the document reference was created.

author

protected List<Reference> author

Identifies who is responsible for adding the information to the document.

attester

protected List<DocumentReference.DocumentReferenceAttesterComponent> attester

A participant who has authenticated the accuracy of the document.

custodian

protected Reference custodian

Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

relatesTo

protected List<DocumentReference.DocumentReferenceRelatesToComponent> relatesTo

Relationships that this document has with other document references that already exist.

description

protected MarkdownType description

Human-readable description of the source document.

securityLabel

protected List<CodeableConcept> securityLabel

A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.

content

protected List<DocumentReference.DocumentReferenceContentComponent> content

The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.

SP_ATTESTER

public static final String SP_ATTESTER

Search parameter: attester

Description: Who attested the document
Type: reference
Path: DocumentReference.attester.party

See Also:

• Constant Field Values

ATTESTER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ATTESTER

Fluent Client search parameter constant for attester

Description: Who attested the document
Type: reference
Path: DocumentReference.attester.party

INCLUDE_ATTESTER

public static final ca.uhn.fhir.model.api.Include INCLUDE_ATTESTER

Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:attester".

SP_AUTHOR

public static final String SP_AUTHOR

Search parameter: author

Description: Who and/or what authored the document
Type: reference
Path: DocumentReference.author

See Also:

• Constant Field Values

AUTHOR

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR

Fluent Client search parameter constant for author

Description: Who and/or what authored the document
Type: reference
Path: DocumentReference.author

INCLUDE_AUTHOR

public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:author".

SP_BASED_ON

public static final String SP_BASED_ON

Search parameter: based-on

Description: Procedure that caused this media to be created
Type: reference
Path: DocumentReference.basedOn

See Also:

• Constant Field Values

BASED_ON

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON

Fluent Client search parameter constant for based-on

Description: Procedure that caused this media to be created
Type: reference
Path: DocumentReference.basedOn

INCLUDE_BASED_ON

public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON

Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:based-on".

SP_BODYSITE_REFERENCE

public static final String SP_BODYSITE_REFERENCE

Search parameter: bodysite-reference

Description: The body site studied
Type: reference
Path: DocumentReference.bodySite.reference

See Also:

• Constant Field Values

BODYSITE_REFERENCE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BODYSITE_REFERENCE

Fluent Client search parameter constant for bodysite-reference

Description: The body site studied
Type: reference
Path: DocumentReference.bodySite.reference

INCLUDE_BODYSITE_REFERENCE

public static final ca.uhn.fhir.model.api.Include INCLUDE_BODYSITE_REFERENCE

Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:bodysite-reference".

SP_BODYSITE

public static final String SP_BODYSITE

Search parameter: bodysite

Description: The body site studied
Type: token
Path: DocumentReference.bodySite.concept

See Also:

• Constant Field Values

BODYSITE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam BODYSITE

Fluent Client search parameter constant for bodysite

Description: The body site studied
Type: token
Path: DocumentReference.bodySite.concept

SP_CATEGORY

public static final String SP_CATEGORY

Search parameter: category

Description: Categorization of document
Type: token
Path: DocumentReference.category

See Also:

• Constant Field Values

CATEGORY

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY

Fluent Client search parameter constant for category

Description: Categorization of document
Type: token
Path: DocumentReference.category

SP_CONTENTTYPE

public static final String SP_CONTENTTYPE

Search parameter: contenttype

Description: Mime type of the content, with charset etc.
Type: token
Path: DocumentReference.content.attachment.contentType

See Also:

• Constant Field Values

CONTENTTYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTENTTYPE

Fluent Client search parameter constant for contenttype

Description: Mime type of the content, with charset etc.
Type: token
Path: DocumentReference.content.attachment.contentType

SP_CONTEXT

public static final String SP_CONTEXT

Search parameter: context

Description: Context of the document content
Type: reference
Path: DocumentReference.context

See Also:

• Constant Field Values

CONTEXT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTEXT

Fluent Client search parameter constant for context

Description: Context of the document content
Type: reference
Path: DocumentReference.context

INCLUDE_CONTEXT

public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT

Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:context".

SP_CREATION

public static final String SP_CREATION

Search parameter: creation

Description: Date attachment was first created
Type: date
Path: DocumentReference.content.attachment.creation

See Also:

• Constant Field Values

CREATION

public static final ca.uhn.fhir.rest.gclient.DateClientParam CREATION

Fluent Client search parameter constant for creation

Description: Date attachment was first created
Type: date
Path: DocumentReference.content.attachment.creation

SP_CUSTODIAN

public static final String SP_CUSTODIAN

Search parameter: custodian

Description: Organization which maintains the document
Type: reference
Path: DocumentReference.custodian

See Also:

• Constant Field Values

CUSTODIAN

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CUSTODIAN

Fluent Client search parameter constant for custodian

Description: Organization which maintains the document
Type: reference
Path: DocumentReference.custodian

INCLUDE_CUSTODIAN

public static final ca.uhn.fhir.model.api.Include INCLUDE_CUSTODIAN

Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:custodian".

SP_DESCRIPTION

public static final String SP_DESCRIPTION

Search parameter: description

Description: Human-readable description
Type: string
Path: DocumentReference.description

See Also:

• Constant Field Values

DESCRIPTION

public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION

Fluent Client search parameter constant for description

Description: Human-readable description
Type: string
Path: DocumentReference.description

SP_DOC_STATUS

public static final String SP_DOC_STATUS

Search parameter: doc-status

Description: preliminary | final | amended | entered-in-error
Type: token
Path: DocumentReference.docStatus

See Also:

• Constant Field Values

DOC_STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam DOC_STATUS

Fluent Client search parameter constant for doc-status

Description: preliminary | final | amended | entered-in-error
Type: token
Path: DocumentReference.docStatus

SP_EVENT_CODE

public static final String SP_EVENT_CODE

Search parameter: event-code

Description: Main clinical acts documented
Type: token
Path: DocumentReference.event.concept

See Also:

• Constant Field Values

EVENT_CODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam EVENT_CODE

Fluent Client search parameter constant for event-code

Description: Main clinical acts documented
Type: token
Path: DocumentReference.event.concept

SP_EVENT_REFERENCE

public static final String SP_EVENT_REFERENCE

Search parameter: event-reference

Description: Main clinical acts documented
Type: reference
Path: DocumentReference.event.reference

See Also:

• Constant Field Values

EVENT_REFERENCE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam EVENT_REFERENCE

Fluent Client search parameter constant for event-reference

Description: Main clinical acts documented
Type: reference
Path: DocumentReference.event.reference

INCLUDE_EVENT_REFERENCE

public static final ca.uhn.fhir.model.api.Include INCLUDE_EVENT_REFERENCE

Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:event-reference".

SP_FACILITY

public static final String SP_FACILITY

Search parameter: facility

Description: Kind of facility where patient was seen
Type: token
Path: DocumentReference.facilityType

See Also:

• Constant Field Values

FACILITY

public static final ca.uhn.fhir.rest.gclient.TokenClientParam FACILITY

Fluent Client search parameter constant for facility

Description: Kind of facility where patient was seen
Type: token
Path: DocumentReference.facilityType

SP_FORMAT_CANONICAL

public static final String SP_FORMAT_CANONICAL

Search parameter: format-canonical

Description: Profile canonical content rules for the document
Type: reference
Path: (DocumentReference.content.profile.value.ofType(canonical))

See Also:

• Constant Field Values

FORMAT_CANONICAL

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam FORMAT_CANONICAL

Fluent Client search parameter constant for format-canonical

Description: Profile canonical content rules for the document
Type: reference
Path: (DocumentReference.content.profile.value.ofType(canonical))

INCLUDE_FORMAT_CANONICAL

public static final ca.uhn.fhir.model.api.Include INCLUDE_FORMAT_CANONICAL

Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:format-canonical".

SP_FORMAT_CODE

public static final String SP_FORMAT_CODE

Search parameter: format-code

Description: Format code content rules for the document
Type: token
Path: (DocumentReference.content.profile.value.ofType(Coding))

See Also:

• Constant Field Values

FORMAT_CODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam FORMAT_CODE

Fluent Client search parameter constant for format-code

Description: Format code content rules for the document
Type: token
Path: (DocumentReference.content.profile.value.ofType(Coding))

SP_FORMAT_URI

public static final String SP_FORMAT_URI

Search parameter: format-uri

Description: Profile URI content rules for the document
Type: uri
Path: (DocumentReference.content.profile.value.ofType(uri))

See Also:

• Constant Field Values

FORMAT_URI

public static final ca.uhn.fhir.rest.gclient.UriClientParam FORMAT_URI

Fluent Client search parameter constant for format-uri

Description: Profile URI content rules for the document
Type: uri
Path: (DocumentReference.content.profile.value.ofType(uri))

SP_LANGUAGE

public static final String SP_LANGUAGE

Search parameter: language

Description: Human language of the content (BCP-47)
Type: token
Path: DocumentReference.content.attachment.language

See Also:

• Constant Field Values

LANGUAGE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam LANGUAGE

Fluent Client search parameter constant for language

Description: Human language of the content (BCP-47)
Type: token
Path: DocumentReference.content.attachment.language

SP_LOCATION

public static final String SP_LOCATION

Search parameter: location

Description: Uri where the data can be found
Type: uri
Path: DocumentReference.content.attachment.url

See Also:

• Constant Field Values

LOCATION

public static final ca.uhn.fhir.rest.gclient.UriClientParam LOCATION

Fluent Client search parameter constant for location

Description: Uri where the data can be found
Type: uri
Path: DocumentReference.content.attachment.url

SP_MODALITY

public static final String SP_MODALITY

Search parameter: modality

Description: The modality used
Type: token
Path: DocumentReference.modality

See Also:

• Constant Field Values

MODALITY

public static final ca.uhn.fhir.rest.gclient.TokenClientParam MODALITY

Fluent Client search parameter constant for modality

Description: The modality used
Type: token
Path: DocumentReference.modality

SP_PERIOD

public static final String SP_PERIOD

Search parameter: period

Description: Time of service that is being documented
Type: date
Path: DocumentReference.period

See Also:

• Constant Field Values

PERIOD

public static final ca.uhn.fhir.rest.gclient.DateClientParam PERIOD

Fluent Client search parameter constant for period

Description: Time of service that is being documented
Type: date
Path: DocumentReference.period

SP_RELATESTO

public static final String SP_RELATESTO

Search parameter: relatesto

Description: Target of the relationship
Type: reference
Path: DocumentReference.relatesTo.target

See Also:

• Constant Field Values

RELATESTO

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RELATESTO

Fluent Client search parameter constant for relatesto

Description: Target of the relationship
Type: reference
Path: DocumentReference.relatesTo.target

INCLUDE_RELATESTO

public static final ca.uhn.fhir.model.api.Include INCLUDE_RELATESTO

Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:relatesto".

SP_RELATION

public static final String SP_RELATION

Search parameter: relation

Description: replaces | transforms | signs | appends
Type: token
Path: DocumentReference.relatesTo.code

See Also:

• Constant Field Values

RELATION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam RELATION

Fluent Client search parameter constant for relation

Description: replaces | transforms | signs | appends
Type: token
Path: DocumentReference.relatesTo.code

SP_RELATIONSHIP

public static final String SP_RELATIONSHIP

Search parameter: relationship

Description: Combination of relation and relatesTo
Type: composite
Path: DocumentReference.relatesTo

See Also:

• Constant Field Values

RELATIONSHIP

public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.ReferenceClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> RELATIONSHIP

Fluent Client search parameter constant for relationship

Description: Combination of relation and relatesTo
Type: composite
Path: DocumentReference.relatesTo

SP_SECURITY_LABEL

public static final String SP_SECURITY_LABEL

Search parameter: security-label

Description: Document security-tags
Type: token
Path: DocumentReference.securityLabel

See Also:

• Constant Field Values

SECURITY_LABEL

public static final ca.uhn.fhir.rest.gclient.TokenClientParam SECURITY_LABEL

Fluent Client search parameter constant for security-label

Description: Document security-tags
Type: token
Path: DocumentReference.securityLabel

SP_SETTING

public static final String SP_SETTING

Search parameter: setting

Description: Additional details about where the content was created (e.g. clinical specialty)
Type: token
Path: DocumentReference.practiceSetting

See Also:

• Constant Field Values

SETTING

public static final ca.uhn.fhir.rest.gclient.TokenClientParam SETTING

Fluent Client search parameter constant for setting

Description: Additional details about where the content was created (e.g. clinical specialty)
Type: token
Path: DocumentReference.practiceSetting

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: current | superseded | entered-in-error
Type: token
Path: DocumentReference.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: current | superseded | entered-in-error
Type: token
Path: DocumentReference.status

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

Description: Who/what is the subject of the document
Type: reference
Path: DocumentReference.subject

See Also:

• Constant Field Values

SUBJECT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT

Fluent Client search parameter constant for subject

Description: Who/what is the subject of the document
Type: reference
Path: DocumentReference.subject

INCLUDE_SUBJECT

public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT

Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:subject".

SP_VERSION

public static final String SP_VERSION

Search parameter: version

Description: The business version identifier
Type: string
Path: DocumentReference.version

See Also:

• Constant Field Values

VERSION

public static final ca.uhn.fhir.rest.gclient.StringClientParam VERSION

Fluent Client search parameter constant for version

Description: The business version identifier
Type: string
Path: DocumentReference.version

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: Multiple Resources: [AdverseEvent](adverseevent.html): When the event occurred [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [Appointment](appointment.html): Appointment date/time. [AuditEvent](auditevent.html): Time when the event was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [DocumentReference](documentreference.html): When this document reference was created [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [ImmunizationEvaluation](immunizationevaluation.html): Date the evaluation was generated [ImmunizationRecommendation](immunizationrecommendation.html): Date recommendation(s) created [Invoice](invoice.html): Invoice date / posting date [List](list.html): When the list was prepared [MeasureReport](measurereport.html): The date of the measure report [NutritionIntake](nutritionintake.html): Date when patient was taking (or not taking) the medication [Observation](observation.html): Clinically relevant time/time-period for observation [Procedure](procedure.html): When the procedure occurred or is occurring [ResearchSubject](researchsubject.html): Start and end of participation [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AdverseEvent.occurrence.ofType(dateTime) | AdverseEvent.occurrence.ofType(Period) | AdverseEvent.occurrence.ofType(Timing) | AllergyIntolerance.recordedDate | (start | requestedPeriod.start).first() | AuditEvent.recorded | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.ofType(dateTime) | DiagnosticReport.effective.ofType(Period) | DocumentReference.date | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence.ofType(dateTime)) | ImmunizationEvaluation.date | ImmunizationRecommendation.date | Invoice.date | List.date | MeasureReport.date | NutritionIntake.occurrence.ofType(dateTime) | NutritionIntake.occurrence.ofType(Period) | Observation.effective.ofType(dateTime) | Observation.effective.ofType(Period) | Observation.effective.ofType(Timing) | Observation.effective.ofType(instant) | Procedure.occurrence.ofType(dateTime) | Procedure.occurrence.ofType(Period) | Procedure.occurrence.ofType(Timing) | ResearchSubject.period | (RiskAssessment.occurrence.ofType(dateTime)) | SupplyRequest.authoredOn

See Also:

• Constant Field Values

DATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE

Fluent Client search parameter constant for date

Description: Multiple Resources: [AdverseEvent](adverseevent.html): When the event occurred [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [Appointment](appointment.html): Appointment date/time. [AuditEvent](auditevent.html): Time when the event was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [DocumentReference](documentreference.html): When this document reference was created [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [ImmunizationEvaluation](immunizationevaluation.html): Date the evaluation was generated [ImmunizationRecommendation](immunizationrecommendation.html): Date recommendation(s) created [Invoice](invoice.html): Invoice date / posting date [List](list.html): When the list was prepared [MeasureReport](measurereport.html): The date of the measure report [NutritionIntake](nutritionintake.html): Date when patient was taking (or not taking) the medication [Observation](observation.html): Clinically relevant time/time-period for observation [Procedure](procedure.html): When the procedure occurred or is occurring [ResearchSubject](researchsubject.html): Start and end of participation [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AdverseEvent.occurrence.ofType(dateTime) | AdverseEvent.occurrence.ofType(Period) | AdverseEvent.occurrence.ofType(Timing) | AllergyIntolerance.recordedDate | (start | requestedPeriod.start).first() | AuditEvent.recorded | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.ofType(dateTime) | DiagnosticReport.effective.ofType(Period) | DocumentReference.date | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence.ofType(dateTime)) | ImmunizationEvaluation.date | ImmunizationRecommendation.date | Invoice.date | List.date | MeasureReport.date | NutritionIntake.occurrence.ofType(dateTime) | NutritionIntake.occurrence.ofType(Period) | Observation.effective.ofType(dateTime) | Observation.effective.ofType(Period) | Observation.effective.ofType(Timing) | Observation.effective.ofType(instant) | Procedure.occurrence.ofType(dateTime) | Procedure.occurrence.ofType(Period) | Procedure.occurrence.ofType(Timing) | ResearchSubject.period | (RiskAssessment.occurrence.ofType(dateTime)) | SupplyRequest.authoredOn

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient

See Also:

• Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient

INCLUDE_PATIENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:patient".

SP_TYPE

public static final String SP_TYPE

Search parameter: type

Description: Multiple Resources: [Account](account.html): E.g. patient, expense, depreciation [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known) [Composition](composition.html): Kind of composition (LOINC if possible) [Coverage](coverage.html): The kind of coverage (health plan, auto, Workers Compensation) [DocumentReference](documentreference.html): Kind of document (LOINC if possible) [Encounter](encounter.html): Specific type of encounter [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management [Invoice](invoice.html): Type of Invoice [MedicationDispense](medicationdispense.html): Returns dispenses of a specific type [MolecularSequence](molecularsequence.html): Amino Acid Sequence/ DNA Sequence / RNA Sequence [Specimen](specimen.html): The specimen type
Type: token
Path: Account.type | AllergyIntolerance.type | Composition.type | Coverage.type | DocumentReference.type | Encounter.type | EpisodeOfCare.type | Invoice.type | MedicationDispense.type | MolecularSequence.type | Specimen.type

See Also:

• Constant Field Values

TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE

Fluent Client search parameter constant for type

Description: Multiple Resources: [Account](account.html): E.g. patient, expense, depreciation [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known) [Composition](composition.html): Kind of composition (LOINC if possible) [Coverage](coverage.html): The kind of coverage (health plan, auto, Workers Compensation) [DocumentReference](documentreference.html): Kind of document (LOINC if possible) [Encounter](encounter.html): Specific type of encounter [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management [Invoice](invoice.html): Type of Invoice [MedicationDispense](medicationdispense.html): Returns dispenses of a specific type [MolecularSequence](molecularsequence.html): Amino Acid Sequence/ DNA Sequence / RNA Sequence [Specimen](specimen.html): The specimen type
Type: token
Path: Account.type | AllergyIntolerance.type | Composition.type | Coverage.type | DocumentReference.type | Encounter.type | EpisodeOfCare.type | Invoice.type | MedicationDispense.type | MolecularSequence.type | Specimen.type

Constructor Details

DocumentReference

public DocumentReference()

Constructor

DocumentReference

public DocumentReference(DocumentReference.DocumentReferenceStatus status,
 DocumentReference.DocumentReferenceContentComponent content)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Other business identifiers associated with the document, including version independent identifiers.)

setIdentifier

public DocumentReference setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public DocumentReference addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist {3}

getVersionElement

public StringType getVersionElement()

Returns:

version (An explicitly assigned identifer of a variation of the content in the DocumentReference.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

hasVersionElement

public boolean hasVersionElement()

hasVersion

public boolean hasVersion()

setVersionElement

public DocumentReference setVersionElement(StringType value)

Parameters:

value - version (An explicitly assigned identifer of a variation of the content in the DocumentReference.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

getVersion

public String getVersion()

Returns:

An explicitly assigned identifer of a variation of the content in the DocumentReference.

setVersion

public DocumentReference setVersion(String value)

Parameters:

value - An explicitly assigned identifer of a variation of the content in the DocumentReference.

getBasedOn

public List<Reference> getBasedOn()

Returns:

basedOn (A procedure that is fulfilled in whole or in part by the creation of this media.)

setBasedOn

public DocumentReference setBasedOn(List<Reference> theBasedOn)

Returns:

Returns a reference to this for easy method chaining

hasBasedOn

public boolean hasBasedOn()

addBasedOn

public Reference addBasedOn()

addBasedOn

public DocumentReference addBasedOn(Reference t)

getBasedOnFirstRep

public Reference getBasedOnFirstRep()

Returns:

The first repetition of repeating field basedOn, creating it if it does not already exist {3}

getStatusElement

public Enumeration<DocumentReference.DocumentReferenceStatus> getStatusElement()

Returns:

status (The status of this document reference.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public DocumentReference setStatusElement(Enumeration<DocumentReference.DocumentReferenceStatus> value)

Parameters:

value - status (The status of this document reference.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public DocumentReference.DocumentReferenceStatus getStatus()

Returns:

The status of this document reference.

setStatus

public DocumentReference setStatus(DocumentReference.DocumentReferenceStatus value)

Parameters:

value - The status of this document reference.

getDocStatusElement

public Enumeration<Enumerations.CompositionStatus> getDocStatusElement()

Returns:

docStatus (The status of the underlying document.). This is the underlying object with id, value and extensions. The accessor "getDocStatus" gives direct access to the value

hasDocStatusElement

public boolean hasDocStatusElement()

hasDocStatus

public boolean hasDocStatus()

setDocStatusElement

public DocumentReference setDocStatusElement(Enumeration<Enumerations.CompositionStatus> value)

Parameters:

value - docStatus (The status of the underlying document.). This is the underlying object with id, value and extensions. The accessor "getDocStatus" gives direct access to the value

getDocStatus

public Enumerations.CompositionStatus getDocStatus()

Returns:

The status of the underlying document.

setDocStatus

public DocumentReference setDocStatus(Enumerations.CompositionStatus value)

Parameters:

value - The status of the underlying document.

getModality

public List<CodeableConcept> getModality()

Returns:

modality (Imaging modality used. This may include both acquisition and non-acquisition modalities.)

setModality

public DocumentReference setModality(List<CodeableConcept> theModality)

Returns:

Returns a reference to this for easy method chaining

hasModality

public boolean hasModality()

addModality

public CodeableConcept addModality()

addModality

public DocumentReference addModality(CodeableConcept t)

getModalityFirstRep

public CodeableConcept getModalityFirstRep()

Returns:

The first repetition of repeating field modality, creating it if it does not already exist {3}

getType

public CodeableConcept getType()

Returns:

type (Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.)

hasType

public boolean hasType()

setType

public DocumentReference setType(CodeableConcept value)

Parameters:

value - type (Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.)

getCategory

public List<CodeableConcept> getCategory()

Returns:

category (A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.)

setCategory

public DocumentReference setCategory(List<CodeableConcept> theCategory)

Returns:

Returns a reference to this for easy method chaining

hasCategory

public boolean hasCategory()

addCategory

public CodeableConcept addCategory()

addCategory

public DocumentReference addCategory(CodeableConcept t)

getCategoryFirstRep

public CodeableConcept getCategoryFirstRep()

Returns:

The first repetition of repeating field category, creating it if it does not already exist {3}

getSubject

public Reference getSubject()

Returns:

subject (Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).)

hasSubject

public boolean hasSubject()

setSubject

public DocumentReference setSubject(Reference value)

Parameters:

value - subject (Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).)

getContext

public List<Reference> getContext()

Returns:

context (Describes the clinical encounter or type of care that the document content is associated with.)

setContext

public DocumentReference setContext(List<Reference> theContext)

Returns:

Returns a reference to this for easy method chaining

hasContext

public boolean hasContext()

addContext

public Reference addContext()

addContext

public DocumentReference addContext(Reference t)

getContextFirstRep

public Reference getContextFirstRep()

Returns:

The first repetition of repeating field context, creating it if it does not already exist {3}

getEvent

public List<CodeableReference> getEvent()

Returns:

event (This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.)

setEvent

public DocumentReference setEvent(List<CodeableReference> theEvent)

Returns:

Returns a reference to this for easy method chaining

hasEvent

public boolean hasEvent()

addEvent

public CodeableReference addEvent()

addEvent

public DocumentReference addEvent(CodeableReference t)

getEventFirstRep

public CodeableReference getEventFirstRep()

Returns:

The first repetition of repeating field event, creating it if it does not already exist {3}

getBodySite

public List<CodeableReference> getBodySite()

Returns:

bodySite (The anatomic structures included in the document.)

setBodySite

public DocumentReference setBodySite(List<CodeableReference> theBodySite)

Returns:

Returns a reference to this for easy method chaining

hasBodySite

public boolean hasBodySite()

addBodySite

public CodeableReference addBodySite()

addBodySite

public DocumentReference addBodySite(CodeableReference t)

getBodySiteFirstRep

public CodeableReference getBodySiteFirstRep()

Returns:

The first repetition of repeating field bodySite, creating it if it does not already exist {3}

getFacilityType

public CodeableConcept getFacilityType()

Returns:

facilityType (The kind of facility where the patient was seen.)

hasFacilityType

public boolean hasFacilityType()

setFacilityType

public DocumentReference setFacilityType(CodeableConcept value)

Parameters:

value - facilityType (The kind of facility where the patient was seen.)

getPracticeSetting

public CodeableConcept getPracticeSetting()

Returns:

practiceSetting (This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.)

hasPracticeSetting

public boolean hasPracticeSetting()

setPracticeSetting

public DocumentReference setPracticeSetting(CodeableConcept value)

Parameters:

value - practiceSetting (This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.)

getPeriod

public Period getPeriod()

Returns:

period (The time period over which the service that is described by the document was provided.)

hasPeriod

public boolean hasPeriod()

setPeriod

public DocumentReference setPeriod(Period value)

Parameters:

value - period (The time period over which the service that is described by the document was provided.)

getDateElement

public InstantType getDateElement()

Returns:

date (When the document reference was created.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

hasDateElement

public boolean hasDateElement()

hasDate

public boolean hasDate()

setDateElement

public DocumentReference setDateElement(InstantType value)

Parameters:

value - date (When the document reference was created.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

getDate

public Date getDate()

Returns:

When the document reference was created.

setDate

public DocumentReference setDate(Date value)

Parameters:

value - When the document reference was created.

getAuthor

public List<Reference> getAuthor()

Returns:

author (Identifies who is responsible for adding the information to the document.)

setAuthor

public DocumentReference setAuthor(List<Reference> theAuthor)

Returns:

Returns a reference to this for easy method chaining

hasAuthor

public boolean hasAuthor()

addAuthor

public Reference addAuthor()

addAuthor

public DocumentReference addAuthor(Reference t)

getAuthorFirstRep

public Reference getAuthorFirstRep()

Returns:

The first repetition of repeating field author, creating it if it does not already exist {3}

getAttester

public List<DocumentReference.DocumentReferenceAttesterComponent> getAttester()

Returns:

attester (A participant who has authenticated the accuracy of the document.)

setAttester

public DocumentReference setAttester(List<DocumentReference.DocumentReferenceAttesterComponent> theAttester)

Returns:

Returns a reference to this for easy method chaining

hasAttester

public boolean hasAttester()

addAttester

public DocumentReference.DocumentReferenceAttesterComponent addAttester()

addAttester

public DocumentReference addAttester(DocumentReference.DocumentReferenceAttesterComponent t)

getAttesterFirstRep

public DocumentReference.DocumentReferenceAttesterComponent getAttesterFirstRep()

Returns:

The first repetition of repeating field attester, creating it if it does not already exist {3}

getCustodian

public Reference getCustodian()

Returns:

custodian (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)

hasCustodian

public boolean hasCustodian()

setCustodian

public DocumentReference setCustodian(Reference value)

Parameters:

value - custodian (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)

getRelatesTo

public List<DocumentReference.DocumentReferenceRelatesToComponent> getRelatesTo()

Returns:

relatesTo (Relationships that this document has with other document references that already exist.)

setRelatesTo

public DocumentReference setRelatesTo(List<DocumentReference.DocumentReferenceRelatesToComponent> theRelatesTo)

Returns:

Returns a reference to this for easy method chaining

hasRelatesTo

public boolean hasRelatesTo()

addRelatesTo

public DocumentReference.DocumentReferenceRelatesToComponent addRelatesTo()

addRelatesTo

public DocumentReference addRelatesTo(DocumentReference.DocumentReferenceRelatesToComponent t)

getRelatesToFirstRep

public DocumentReference.DocumentReferenceRelatesToComponent getRelatesToFirstRep()

Returns:

The first repetition of repeating field relatesTo, creating it if it does not already exist {3}

getDescriptionElement

public MarkdownType getDescriptionElement()

Returns:

description (Human-readable description of the source document.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public DocumentReference setDescriptionElement(MarkdownType value)

Parameters:

value - description (Human-readable description of the source document.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

Human-readable description of the source document.

setDescription

public DocumentReference setDescription(String value)

Parameters:

value - Human-readable description of the source document.

getSecurityLabel

public List<CodeableConcept> getSecurityLabel()

Returns:

securityLabel (A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.)

setSecurityLabel

public DocumentReference setSecurityLabel(List<CodeableConcept> theSecurityLabel)

Returns:

Returns a reference to this for easy method chaining

hasSecurityLabel

public boolean hasSecurityLabel()

addSecurityLabel

public CodeableConcept addSecurityLabel()

addSecurityLabel

public DocumentReference addSecurityLabel(CodeableConcept t)

getSecurityLabelFirstRep

public CodeableConcept getSecurityLabelFirstRep()

Returns:

The first repetition of repeating field securityLabel, creating it if it does not already exist {3}

getContent

public List<DocumentReference.DocumentReferenceContentComponent> getContent()

Returns:

content (The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.)

setContent

public DocumentReference setContent(List<DocumentReference.DocumentReferenceContentComponent> theContent)

Returns:

Returns a reference to this for easy method chaining

hasContent

public boolean hasContent()

addContent

public DocumentReference.DocumentReferenceContentComponent addContent()

addContent

public DocumentReference addContent(DocumentReference.DocumentReferenceContentComponent t)

getContentFirstRep

public DocumentReference.DocumentReferenceContentComponent getContentFirstRep()

Returns:

The first repetition of repeating field content, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public DocumentReference copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(DocumentReference dst)

typedCopy

protected DocumentReference typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource