DocumentReference (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseResource
  - - ca.uhn.fhir.model.dstu.resource.DocumentReference

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class DocumentReference
extends BaseResource
implements IResource
```
HAPI/FHIR DocumentReference Resource (A reference to a document)
Definition: A reference to a document

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/DocumentReference

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DocumentReference.Context` Block class for child element: DocumentReference.context (Clinical context of document)
`static class`	`DocumentReference.RelatesTo` Block class for child element: DocumentReference.relatesTo (Relationships to other documents)
`static class`	`DocumentReference.Service` Block class for child element: DocumentReference.service (If access is not fully described by location)
`static class`	`DocumentReference.ServiceParameter` Block class for child element: DocumentReference.service.parameter (Service call parameters)

Field Summary

Fields
Modifier and Type	Field and Description
`static ReferenceClientParam`	`AUTHENTICATOR` Fluent Client search parameter constant for authenticator
`static ReferenceClientParam`	`AUTHOR` Fluent Client search parameter constant for author
`static TokenClientParam`	`CLASS` Fluent Client search parameter constant for class
`static TokenClientParam`	`CONFIDENTIALITY` Fluent Client search parameter constant for confidentiality
`static DateClientParam`	`CREATED` Fluent Client search parameter constant for created
`static ReferenceClientParam`	`CUSTODIAN` Fluent Client search parameter constant for custodian
`static StringClientParam`	`DESCRIPTION` Fluent Client search parameter constant for description
`static TokenClientParam`	`EVENT` Fluent Client search parameter constant for event
`static TokenClientParam`	`FACILITY` Fluent Client search parameter constant for facility
`static TokenClientParam`	`FORMAT` Fluent Client search parameter constant for format
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_AUTHENTICATOR` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_AUTHOR` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_CUSTODIAN` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_RELATESTO_TARGET` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`static DateClientParam`	`INDEXED` Fluent Client search parameter constant for indexed
`static TokenClientParam`	`LANGUAGE` Fluent Client search parameter constant for language
`static StringClientParam`	`LOCATION` Fluent Client search parameter constant for location
`static DateClientParam`	`PERIOD` Fluent Client search parameter constant for period
`static ReferenceClientParam`	`RELATESTO` Fluent Client search parameter constant for relatesto
`static CompositeClientParam<ReferenceClientParam,TokenClientParam>`	`RELATESTO_RELATION` Fluent Client search parameter constant for relatesto-relation
`static TokenClientParam`	`RELATION` Fluent Client search parameter constant for relation
`static NumberClientParam`	`SIZE` Fluent Client search parameter constant for size
`static String`	`SP_AUTHENTICATOR` Search parameter constant for authenticator
`static String`	`SP_AUTHOR` Search parameter constant for author
`static String`	`SP_CLASS` Search parameter constant for class
`static String`	`SP_CONFIDENTIALITY` Search parameter constant for confidentiality
`static String`	`SP_CREATED` Search parameter constant for created
`static String`	`SP_CUSTODIAN` Search parameter constant for custodian
`static String`	`SP_DESCRIPTION` Search parameter constant for description
`static String`	`SP_EVENT` Search parameter constant for event
`static String`	`SP_FACILITY` Search parameter constant for facility
`static String`	`SP_FORMAT` Search parameter constant for format
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_INDEXED` Search parameter constant for indexed
`static String`	`SP_LANGUAGE` Search parameter constant for language
`static String`	`SP_LOCATION` Search parameter constant for location
`static String`	`SP_PERIOD` Search parameter constant for period
`static String`	`SP_RELATESTO` Search parameter constant for relatesto
`static String`	`SP_RELATESTO_RELATION` Search parameter constant for relatesto-relation
`static String`	`SP_RELATION` Search parameter constant for relation
`static String`	`SP_SIZE` Search parameter constant for size
`static String`	`SP_STATUS` Search parameter constant for status
`static String`	`SP_SUBJECT` Search parameter constant for subject
`static String`	`SP_TYPE` Search parameter constant for type
`static TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`static ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`static TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

DocumentReference()

Constructors
Constructor and Description
`DocumentReference()`

Method Summary

Methods
Modifier and Type	Method and Description
`ResourceReferenceDt`	`addAuthor()` Adds and returns a new value for author (Who and/or what authored the document)
`CodeableConceptDt`	`addConfidentiality()` Adds and returns a new value for confidentiality (Sensitivity of source document)
`UriDt`	`addFormat()` Adds and returns a new value for format (Format/content rules for the document)
`DocumentReference`	`addFormat(String theUri)` Adds a new value for format (Format/content rules for the document)
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (Other identifiers for the document)
`DocumentReference`	`addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Adds a new value for identifier (Other identifiers for the document)
`DocumentReference`	`addIdentifier(String theSystem, String theValue)` Adds a new value for identifier (Other identifiers for the document)
`DocumentReference.RelatesTo`	`addRelatesTo()` Adds and returns a new value for relatesTo (Relationships to other documents)
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`ResourceReferenceDt`	`getAuthenticator()` Gets the value(s) for authenticator (Who/What authenticated the document).
`List<ResourceReferenceDt>`	`getAuthor()` Gets the value(s) for author (Who and/or what authored the document).
`CodeableConceptDt`	`getClassElement()` Gets the value(s) for class (Categorization of Document).
`List<CodeableConceptDt>`	`getConfidentiality()` Gets the value(s) for confidentiality (Sensitivity of source document).
`CodeableConceptDt`	`getConfidentialityFirstRep()` Gets the first repetition for confidentiality (Sensitivity of source document), creating it if it does not already exist.
`DocumentReference.Context`	`getContext()` Gets the value(s) for context (Clinical context of document).
`DateTimeDt`	`getCreated()` Gets the value(s) for created (Document creation time).
`ResourceReferenceDt`	`getCustodian()` Gets the value(s) for custodian (Org which maintains the document).
`StringDt`	`getDescription()` Gets the value(s) for description (Human-readable description (title)).
`CodeableConceptDt`	`getDocStatus()` Gets the value(s) for docStatus (preliminary \| final \| appended \| amended \| entered in error).
`List<UriDt>`	`getFormat()` Gets the value(s) for format (Format/content rules for the document).
`UriDt`	`getFormatFirstRep()` Gets the first repetition for format (Format/content rules for the document), creating it if it does not already exist.
`StringDt`	`getHash()` Gets the value(s) for hash (HexBinary representation of SHA1).
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (Other identifiers for the document).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (Other identifiers for the document), creating it if it does not already exist.
`InstantDt`	`getIndexed()` Gets the value(s) for indexed (When this document reference created).
`UriDt`	`getLocation()` Gets the value(s) for location (Where to access the document).
`IdentifierDt`	`getMasterIdentifier()` Gets the value(s) for masterIdentifier (Master Version Specific Identifier).
`CodeDt`	`getMimeType()` Gets the value(s) for mimeType (Mime type, + maybe character encoding).
`UriDt`	`getPolicyManager()` Gets the value(s) for policyManager (Manages access policies for the document).
`CodeDt`	`getPrimaryLanguage()` Gets the value(s) for primaryLanguage (The marked primary language for the document).
`List<DocumentReference.RelatesTo>`	`getRelatesTo()` Gets the value(s) for relatesTo (Relationships to other documents).
`DocumentReference.RelatesTo`	`getRelatesToFirstRep()` Gets the first repetition for relatesTo (Relationships to other documents), creating it if it does not already exist.
`DocumentReference.Service`	`getService()` Gets the value(s) for service (If access is not fully described by location).
`IntegerDt`	`getSize()` Gets the value(s) for size (Size of the document in bytes).
`BoundCodeDt<DocumentReferenceStatusEnum>`	`getStatus()` Gets the value(s) for status (current \| superceded \| entered in error).
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject (Who\|what is the subject of the document).
`CodeableConceptDt`	`getType()` Gets the value(s) for type (What kind of document this is (LOINC if possible)).
`boolean`	`isEmpty()`
`DocumentReference`	`setAuthenticator(ResourceReferenceDt theValue)` Sets the value(s) for authenticator (Who/What authenticated the document)
`DocumentReference`	`setAuthor(List<ResourceReferenceDt> theValue)` Sets the value(s) for author (Who and/or what authored the document)
`DocumentReference`	`setClassElement(CodeableConceptDt theValue)` Sets the value(s) for class (Categorization of Document)
`DocumentReference`	`setConfidentiality(List<CodeableConceptDt> theValue)` Sets the value(s) for confidentiality (Sensitivity of source document)
`DocumentReference`	`setContext(DocumentReference.Context theValue)` Sets the value(s) for context (Clinical context of document)
`DocumentReference`	`setCreated(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for created (Document creation time)
`DocumentReference`	`setCreated(DateTimeDt theValue)` Sets the value(s) for created (Document creation time)
`DocumentReference`	`setCreatedWithSecondsPrecision(Date theDate)` Sets the value for created (Document creation time)
`DocumentReference`	`setCustodian(ResourceReferenceDt theValue)` Sets the value(s) for custodian (Org which maintains the document)
`DocumentReference`	`setDescription(String theString)` Sets the value for description (Human-readable description (title))
`DocumentReference`	`setDescription(StringDt theValue)` Sets the value(s) for description (Human-readable description (title))
`DocumentReference`	`setDocStatus(CodeableConceptDt theValue)` Sets the value(s) for docStatus (preliminary \| final \| appended \| amended \| entered in error)
`DocumentReference`	`setFormat(List<UriDt> theValue)` Sets the value(s) for format (Format/content rules for the document)
`DocumentReference`	`setHash(String theString)` Sets the value for hash (HexBinary representation of SHA1)
`DocumentReference`	`setHash(StringDt theValue)` Sets the value(s) for hash (HexBinary representation of SHA1)
`DocumentReference`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (Other identifiers for the document)
`DocumentReference`	`setIndexed(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for indexed (When this document reference created)
`DocumentReference`	`setIndexed(InstantDt theValue)` Sets the value(s) for indexed (When this document reference created)
`DocumentReference`	`setIndexedWithMillisPrecision(Date theDate)` Sets the value for indexed (When this document reference created)
`DocumentReference`	`setLocation(String theUri)` Sets the value for location (Where to access the document)
`DocumentReference`	`setLocation(UriDt theValue)` Sets the value(s) for location (Where to access the document)
`DocumentReference`	`setMasterIdentifier(IdentifierDt theValue)` Sets the value(s) for masterIdentifier (Master Version Specific Identifier)
`DocumentReference`	`setMasterIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Sets the value for masterIdentifier (Master Version Specific Identifier)
`DocumentReference`	`setMasterIdentifier(String theSystem, String theValue)` Sets the value for masterIdentifier (Master Version Specific Identifier)
`DocumentReference`	`setMimeType(CodeDt theValue)` Sets the value(s) for mimeType (Mime type, + maybe character encoding)
`DocumentReference`	`setMimeType(String theCode)` Sets the value for mimeType (Mime type, + maybe character encoding)
`DocumentReference`	`setPolicyManager(String theUri)` Sets the value for policyManager (Manages access policies for the document)
`DocumentReference`	`setPolicyManager(UriDt theValue)` Sets the value(s) for policyManager (Manages access policies for the document)
`DocumentReference`	`setPrimaryLanguage(CodeDt theValue)` Sets the value(s) for primaryLanguage (The marked primary language for the document)
`DocumentReference`	`setPrimaryLanguage(String theCode)` Sets the value for primaryLanguage (The marked primary language for the document)
`DocumentReference`	`setRelatesTo(List<DocumentReference.RelatesTo> theValue)` Sets the value(s) for relatesTo (Relationships to other documents)
`DocumentReference`	`setService(DocumentReference.Service theValue)` Sets the value(s) for service (If access is not fully described by location)
`DocumentReference`	`setSize(int theInteger)` Sets the value for size (Size of the document in bytes)
`DocumentReference`	`setSize(IntegerDt theValue)` Sets the value(s) for size (Size of the document in bytes)
`DocumentReference`	`setStatus(BoundCodeDt<DocumentReferenceStatusEnum> theValue)` Sets the value(s) for status (current \| superceded \| entered in error)
`DocumentReference`	`setStatus(DocumentReferenceStatusEnum theValue)` Sets the value(s) for status (current \| superceded \| entered in error)
`DocumentReference`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject (Who\|what is the subject of the document)
`DocumentReference`	`setType(CodeableConceptDt theValue)` Sets the value(s) for type (What kind of document this is (LOINC if possible))

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

- Field Detail
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description:
    Type: token
    Path: DocumentReference.masterIdentifier | DocumentReference.identifier
    
    See Also:
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description:
    Type: token
    Path: DocumentReference.masterIdentifier | DocumentReference.identifier
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter constant for subject
    Description:
    Type: reference
    Path: DocumentReference.subject
    
    See Also:
    Constant Field Values
  - SUBJECT
```
public static final ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description:
    Type: reference
    Path: DocumentReference.subject
  - INCLUDE_SUBJECT
```
public static final Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference.subject".
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter constant for type
    Description:
    Type: token
    Path: DocumentReference.type
    
    See Also:
    Constant Field Values
  - TYPE
```
public static final TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description:
    Type: token
    Path: DocumentReference.type
  - SP_CLASS
```
public static final String SP_CLASS
```
    Search parameter constant for class
    Description:
    Type: token
    Path: DocumentReference.class
    
    See Also:
    Constant Field Values
  - CLASS
```
public static final TokenClientParam CLASS
```
    Fluent Client search parameter constant for class
    Description:
    Type: token
    Path: DocumentReference.class
  - SP_AUTHOR
```
public static final String SP_AUTHOR
```
    Search parameter constant for author
    Description:
    Type: reference
    Path: DocumentReference.author
    
    See Also:
    Constant Field Values
  - AUTHOR
```
public static final ReferenceClientParam AUTHOR
```
    Fluent Client search parameter constant for author
    Description:
    Type: reference
    Path: DocumentReference.author
  - INCLUDE_AUTHOR
```
public static final Include INCLUDE_AUTHOR
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference.author".
  - SP_CUSTODIAN
```
public static final String SP_CUSTODIAN
```
    Search parameter constant for custodian
    Description:
    Type: reference
    Path: DocumentReference.custodian
    
    See Also:
    Constant Field Values
  - CUSTODIAN
```
public static final ReferenceClientParam CUSTODIAN
```
    Fluent Client search parameter constant for custodian
    Description:
    Type: reference
    Path: DocumentReference.custodian
  - INCLUDE_CUSTODIAN
```
public static final Include INCLUDE_CUSTODIAN
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference.custodian".
  - SP_AUTHENTICATOR
```
public static final String SP_AUTHENTICATOR
```
    Search parameter constant for authenticator
    Description:
    Type: reference
    Path: DocumentReference.authenticator
    
    See Also:
    Constant Field Values
  - AUTHENTICATOR
```
public static final ReferenceClientParam AUTHENTICATOR
```
    Fluent Client search parameter constant for authenticator
    Description:
    Type: reference
    Path: DocumentReference.authenticator
  - INCLUDE_AUTHENTICATOR
```
public static final Include INCLUDE_AUTHENTICATOR
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference.authenticator".
  - SP_CREATED
```
public static final String SP_CREATED
```
    Search parameter constant for created
    Description:
    Type: date
    Path: DocumentReference.created
    
    See Also:
    Constant Field Values
  - CREATED
```
public static final DateClientParam CREATED
```
    Fluent Client search parameter constant for created
    Description:
    Type: date
    Path: DocumentReference.created
  - SP_INDEXED
```
public static final String SP_INDEXED
```
    Search parameter constant for indexed
    Description:
    Type: date
    Path: DocumentReference.indexed
    
    See Also:
    Constant Field Values
  - INDEXED
```
public static final DateClientParam INDEXED
```
    Fluent Client search parameter constant for indexed
    Description:
    Type: date
    Path: DocumentReference.indexed
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter constant for status
    Description:
    Type: token
    Path: DocumentReference.status
    
    See Also:
    Constant Field Values
  - STATUS
```
public static final TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description:
    Type: token
    Path: DocumentReference.status
  - SP_RELATESTO
```
public static final String SP_RELATESTO
```
    Search parameter constant for relatesto
    Description:
    Type: reference
    Path: DocumentReference.relatesTo.target
    
    See Also:
    Constant Field Values
  - RELATESTO
```
public static final ReferenceClientParam RELATESTO
```
    Fluent Client search parameter constant for relatesto
    Description:
    Type: reference
    Path: DocumentReference.relatesTo.target
  - INCLUDE_RELATESTO_TARGET
```
public static final Include INCLUDE_RELATESTO_TARGET
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference.relatesTo.target".
  - SP_RELATION
```
public static final String SP_RELATION
```
    Search parameter constant for relation
    Description:
    Type: token
    Path: DocumentReference.relatesTo.code
    
    See Also:
    Constant Field Values
  - RELATION
```
public static final TokenClientParam RELATION
```
    Fluent Client search parameter constant for relation
    Description:
    Type: token
    Path: DocumentReference.relatesTo.code
  - SP_DESCRIPTION
```
public static final String SP_DESCRIPTION
```
    Search parameter constant for description
    Description:
    Type: string
    Path: DocumentReference.description
    
    See Also:
    Constant Field Values
  - DESCRIPTION
```
public static final StringClientParam DESCRIPTION
```
    Fluent Client search parameter constant for description
    Description:
    Type: string
    Path: DocumentReference.description
  - SP_CONFIDENTIALITY
```
public static final String SP_CONFIDENTIALITY
```
    Search parameter constant for confidentiality
    Description:
    Type: token
    Path: DocumentReference.confidentiality
    
    See Also:
    Constant Field Values
  - CONFIDENTIALITY
```
public static final TokenClientParam CONFIDENTIALITY
```
    Fluent Client search parameter constant for confidentiality
    Description:
    Type: token
    Path: DocumentReference.confidentiality
  - SP_LANGUAGE
```
public static final String SP_LANGUAGE
```
    Search parameter constant for language
    Description:
    Type: token
    Path: DocumentReference.primaryLanguage
    
    See Also:
    Constant Field Values
  - LANGUAGE
```
public static final TokenClientParam LANGUAGE
```
    Fluent Client search parameter constant for language
    Description:
    Type: token
    Path: DocumentReference.primaryLanguage
  - SP_FORMAT
```
public static final String SP_FORMAT
```
    Search parameter constant for format
    Description:
    Type: token
    Path: DocumentReference.format
    
    See Also:
    Constant Field Values
  - FORMAT
```
public static final TokenClientParam FORMAT
```
    Fluent Client search parameter constant for format
    Description:
    Type: token
    Path: DocumentReference.format
  - SP_SIZE
```
public static final String SP_SIZE
```
    Search parameter constant for size
    Description:
    Type: number
    Path: DocumentReference.size
    
    See Also:
    Constant Field Values
  - SIZE
```
public static final NumberClientParam SIZE
```
    Fluent Client search parameter constant for size
    Description:
    Type: number
    Path: DocumentReference.size
  - SP_LOCATION
```
public static final String SP_LOCATION
```
    Search parameter constant for location
    Description:
    Type: string
    Path: DocumentReference.location
    
    See Also:
    Constant Field Values
  - LOCATION
```
public static final StringClientParam LOCATION
```
    Fluent Client search parameter constant for location
    Description:
    Type: string
    Path: DocumentReference.location
  - SP_EVENT
```
public static final String SP_EVENT
```
    Search parameter constant for event
    Description:
    Type: token
    Path: DocumentReference.context.event
    
    See Also:
    Constant Field Values
  - EVENT
```
public static final TokenClientParam EVENT
```
    Fluent Client search parameter constant for event
    Description:
    Type: token
    Path: DocumentReference.context.event
  - SP_PERIOD
```
public static final String SP_PERIOD
```
    Search parameter constant for period
    Description:
    Type: date
    Path: DocumentReference.context.period
    
    See Also:
    Constant Field Values
  - PERIOD
```
public static final DateClientParam PERIOD
```
    Fluent Client search parameter constant for period
    Description:
    Type: date
    Path: DocumentReference.context.period
  - SP_FACILITY
```
public static final String SP_FACILITY
```
    Search parameter constant for facility
    Description:
    Type: token
    Path: DocumentReference.context.facilityType
    
    See Also:
    Constant Field Values
  - FACILITY
```
public static final TokenClientParam FACILITY
```
    Fluent Client search parameter constant for facility
    Description:
    Type: token
    Path: DocumentReference.context.facilityType
  - SP_RELATESTO_RELATION
```
public static final String SP_RELATESTO_RELATION
```
    Search parameter constant for relatesto-relation
    Description: Combination of relation and relatesTo
    Type: composite
    Path: relatesto & relation
    
    See Also:
    Constant Field Values
  - RELATESTO_RELATION
```
public static final CompositeClientParam<ReferenceClientParam,TokenClientParam> RELATESTO_RELATION
```
    Fluent Client search parameter constant for relatesto-relation
    Description: Combination of relation and relatesTo
    Type: composite
    Path: relatesto & relation
- Constructor Detail
  - DocumentReference
```
public DocumentReference()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getMasterIdentifier
```
public IdentifierDt getMasterIdentifier()
```
    Gets the value(s) for masterIdentifier (Master Version Specific Identifier). creating it if it does not exist. Will not return null.
    Definition: Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document
  - setMasterIdentifier
```
public DocumentReference setMasterIdentifier(IdentifierDt theValue)
```
    Sets the value(s) for masterIdentifier (Master Version Specific Identifier)
    Definition: Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document
  - setMasterIdentifier
```
public DocumentReference setMasterIdentifier(IdentifierUseEnum theUse,
                                    String theSystem,
                                    String theValue,
                                    String theLabel)
```
    Sets the value for masterIdentifier (Master Version Specific Identifier)
    Definition: Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document
  - setMasterIdentifier
```
public DocumentReference setMasterIdentifier(String theSystem,
                                    String theValue)
```
    Sets the value for masterIdentifier (Master Version Specific Identifier)
    Definition: Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (Other identifiers for the document). creating it if it does not exist. Will not return null.
    Definition: Other identifiers associated with the document, including version independent, source record and workflow related identifiers
  - setIdentifier
```
public DocumentReference setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (Other identifiers for the document)
    Definition: Other identifiers associated with the document, including version independent, source record and workflow related identifiers
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (Other identifiers for the document)
    Definition: Other identifiers associated with the document, including version independent, source record and workflow related identifiers
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (Other identifiers for the document), creating it if it does not already exist.
    Definition: Other identifiers associated with the document, including version independent, source record and workflow related identifiers
  - addIdentifier
```
public DocumentReference addIdentifier(IdentifierUseEnum theUse,
                              String theSystem,
                              String theValue,
                              String theLabel)
```
    Adds a new value for identifier (Other identifiers for the document)
    Definition: Other identifiers associated with the document, including version independent, source record and workflow related identifiers
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addIdentifier
```
public DocumentReference addIdentifier(String theSystem,
                              String theValue)
```
    Adds a new value for identifier (Other identifiers for the document)
    Definition: Other identifiers associated with the document, including version independent, source record and workflow related identifiers
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getSubject
```
public ResourceReferenceDt getSubject()
```
    Gets the value(s) for subject (Who|what is the subject of the document). creating it if it does not exist. Will not return null.
    Definition: Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (I.e. 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)
  - setSubject
```
public DocumentReference setSubject(ResourceReferenceDt theValue)
```
    Sets the value(s) for subject (Who|what is the subject of the document)
    Definition: Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (I.e. 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)
  - getType
```
public CodeableConceptDt getType()
```
    Gets the value(s) for type (What kind of document this is (LOINC if possible)). creating it if it does not exist. Will not return null.
    Definition: Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.)
  - setType
```
public DocumentReference setType(CodeableConceptDt theValue)
```
    Sets the value(s) for type (What kind of document this is (LOINC if possible))
    Definition: Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.)
  - getClassElement
```
public CodeableConceptDt getClassElement()
```
    Gets the value(s) for class (Categorization of Document). creating it if it does not exist. Will not return null.
    Definition: A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type
  - setClassElement
```
public DocumentReference setClassElement(CodeableConceptDt theValue)
```
    Sets the value(s) for class (Categorization of Document)
    Definition: A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type
  - getAuthor
```
public List<ResourceReferenceDt> getAuthor()
```
    Gets the value(s) for author (Who and/or what authored the document). creating it if it does not exist. Will not return null.
    Definition: Identifies who is responsible for adding the information to the document
  - setAuthor
```
public DocumentReference setAuthor(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for author (Who and/or what authored the document)
    Definition: Identifies who is responsible for adding the information to the document
  - addAuthor
```
public ResourceReferenceDt addAuthor()
```
    Adds and returns a new value for author (Who and/or what authored the document)
    Definition: Identifies who is responsible for adding the information to the document
  - getCustodian
```
public ResourceReferenceDt getCustodian()
```
    Gets the value(s) for custodian (Org which maintains the document). creating it if it does not exist. Will not return null.
    Definition: Identifies the organization or group who is responsible for ongoing maintenance of and access to the document
  - setCustodian
```
public DocumentReference setCustodian(ResourceReferenceDt theValue)
```
    Sets the value(s) for custodian (Org which maintains the document)
    Definition: Identifies the organization or group who is responsible for ongoing maintenance of and access to the document
  - getPolicyManager
```
public UriDt getPolicyManager()
```
    Gets the value(s) for policyManager (Manages access policies for the document). creating it if it does not exist. Will not return null.
    Definition: A reference to a domain or server that manages policies under which the document is accessed and/or made available
  - setPolicyManager
```
public DocumentReference setPolicyManager(UriDt theValue)
```
    Sets the value(s) for policyManager (Manages access policies for the document)
    Definition: A reference to a domain or server that manages policies under which the document is accessed and/or made available
  - setPolicyManager
```
public DocumentReference setPolicyManager(String theUri)
```
    Sets the value for policyManager (Manages access policies for the document)
    Definition: A reference to a domain or server that manages policies under which the document is accessed and/or made available
  - getAuthenticator
```
public ResourceReferenceDt getAuthenticator()
```
    Gets the value(s) for authenticator (Who/What authenticated the document). creating it if it does not exist. Will not return null.
    Definition: Which person or organization authenticates that this document is valid
  - setAuthenticator
```
public DocumentReference setAuthenticator(ResourceReferenceDt theValue)
```
    Sets the value(s) for authenticator (Who/What authenticated the document)
    Definition: Which person or organization authenticates that this document is valid
  - getCreated
```
public DateTimeDt getCreated()
```
    Gets the value(s) for created (Document creation time). creating it if it does not exist. Will not return null.
    Definition: When the document was created
  - setCreated
```
public DocumentReference setCreated(DateTimeDt theValue)
```
    Sets the value(s) for created (Document creation time)
    Definition: When the document was created
  - setCreatedWithSecondsPrecision
```
public DocumentReference setCreatedWithSecondsPrecision(Date theDate)
```
    Sets the value for created (Document creation time)
    Definition: When the document was created
  - setCreated
```
public DocumentReference setCreated(Date theDate,
                           TemporalPrecisionEnum thePrecision)
```
    Sets the value for created (Document creation time)
    Definition: When the document was created
  - getIndexed
```
public InstantDt getIndexed()
```
    Gets the value(s) for indexed (When this document reference created). creating it if it does not exist. Will not return null.
    Definition: When the document reference was created
  - setIndexed
```
public DocumentReference setIndexed(InstantDt theValue)
```
    Sets the value(s) for indexed (When this document reference created)
    Definition: When the document reference was created
  - setIndexed
```
public DocumentReference setIndexed(Date theDate,
                           TemporalPrecisionEnum thePrecision)
```
    Sets the value for indexed (When this document reference created)
    Definition: When the document reference was created
  - setIndexedWithMillisPrecision
```
public DocumentReference setIndexedWithMillisPrecision(Date theDate)
```
    Sets the value for indexed (When this document reference created)
    Definition: When the document reference was created
  - getStatus
```
public BoundCodeDt<DocumentReferenceStatusEnum> getStatus()
```
    Gets the value(s) for status (current | superceded | entered in error). creating it if it does not exist. Will not return null.
    Definition: The status of this document reference
  - setStatus
```
public DocumentReference setStatus(BoundCodeDt<DocumentReferenceStatusEnum> theValue)
```
    Sets the value(s) for status (current | superceded | entered in error)
    Definition: The status of this document reference
  - setStatus
```
public DocumentReference setStatus(DocumentReferenceStatusEnum theValue)
```
    Sets the value(s) for status (current | superceded | entered in error)
    Definition: The status of this document reference
  - getDocStatus
```
public CodeableConceptDt getDocStatus()
```
    Gets the value(s) for docStatus (preliminary | final | appended | amended | entered in error). creating it if it does not exist. Will not return null.
    Definition: The status of the underlying document
  - setDocStatus
```
public DocumentReference setDocStatus(CodeableConceptDt theValue)
```
    Sets the value(s) for docStatus (preliminary | final | appended | amended | entered in error)
    Definition: The status of the underlying document
  - getRelatesTo
```
public List<DocumentReference.RelatesTo> getRelatesTo()
```
    Gets the value(s) for relatesTo (Relationships to other documents). creating it if it does not exist. Will not return null.
    Definition: Relationships that this document has with other document references that already exist
  - setRelatesTo
```
public DocumentReference setRelatesTo(List<DocumentReference.RelatesTo> theValue)
```
    Sets the value(s) for relatesTo (Relationships to other documents)
    Definition: Relationships that this document has with other document references that already exist
  - addRelatesTo
```
public DocumentReference.RelatesTo addRelatesTo()
```
    Adds and returns a new value for relatesTo (Relationships to other documents)
    Definition: Relationships that this document has with other document references that already exist
  - getRelatesToFirstRep
```
public DocumentReference.RelatesTo getRelatesToFirstRep()
```
    Gets the first repetition for relatesTo (Relationships to other documents), creating it if it does not already exist.
    Definition: Relationships that this document has with other document references that already exist
  - getDescription
```
public StringDt getDescription()
```
    Gets the value(s) for description (Human-readable description (title)). creating it if it does not exist. Will not return null.
    Definition: Human-readable description of the source document. This is sometimes known as the \"title\"
  - setDescription
```
public DocumentReference setDescription(StringDt theValue)
```
    Sets the value(s) for description (Human-readable description (title))
    Definition: Human-readable description of the source document. This is sometimes known as the \"title\"
  - setDescription
```
public DocumentReference setDescription(String theString)
```
    Sets the value for description (Human-readable description (title))
    Definition: Human-readable description of the source document. This is sometimes known as the \"title\"
  - getConfidentiality
```
public List<CodeableConceptDt> getConfidentiality()
```
    Gets the value(s) for confidentiality (Sensitivity of source document). creating it if it does not exist. Will not return null.
    Definition: A code specifying the level of confidentiality of the XDS Document
  - setConfidentiality
```
public DocumentReference setConfidentiality(List<CodeableConceptDt> theValue)
```
    Sets the value(s) for confidentiality (Sensitivity of source document)
    Definition: A code specifying the level of confidentiality of the XDS Document
  - addConfidentiality
```
public CodeableConceptDt addConfidentiality()
```
    Adds and returns a new value for confidentiality (Sensitivity of source document)
    Definition: A code specifying the level of confidentiality of the XDS Document
  - getConfidentialityFirstRep
```
public CodeableConceptDt getConfidentialityFirstRep()
```
    Gets the first repetition for confidentiality (Sensitivity of source document), creating it if it does not already exist.
    Definition: A code specifying the level of confidentiality of the XDS Document
  - getPrimaryLanguage
```
public CodeDt getPrimaryLanguage()
```
    Gets the value(s) for primaryLanguage (The marked primary language for the document). creating it if it does not exist. Will not return null.
    Definition: The primary language in which the source document is written
  - setPrimaryLanguage
```
public DocumentReference setPrimaryLanguage(CodeDt theValue)
```
    Sets the value(s) for primaryLanguage (The marked primary language for the document)
    Definition: The primary language in which the source document is written
  - setPrimaryLanguage
```
public DocumentReference setPrimaryLanguage(String theCode)
```
    Sets the value for primaryLanguage (The marked primary language for the document)
    Definition: The primary language in which the source document is written
  - getMimeType
```
public CodeDt getMimeType()
```
    Gets the value(s) for mimeType (Mime type, + maybe character encoding). creating it if it does not exist. Will not return null.
    Definition: The mime type of the source document
  - setMimeType
```
public DocumentReference setMimeType(CodeDt theValue)
```
    Sets the value(s) for mimeType (Mime type, + maybe character encoding)
    Definition: The mime type of the source document
  - setMimeType
```
public DocumentReference setMimeType(String theCode)
```
    Sets the value for mimeType (Mime type, + maybe character encoding)
    Definition: The mime type of the source document
  - getFormat
```
public List<UriDt> getFormat()
```
    Gets the value(s) for format (Format/content rules for the document). creating it if it does not exist. Will not return null.
    Definition: An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType
  - setFormat
```
public DocumentReference setFormat(List<UriDt> theValue)
```
    Sets the value(s) for format (Format/content rules for the document)
    Definition: An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType
  - addFormat
```
public UriDt addFormat()
```
    Adds and returns a new value for format (Format/content rules for the document)
    Definition: An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType
  - getFormatFirstRep
```
public UriDt getFormatFirstRep()
```
    Gets the first repetition for format (Format/content rules for the document), creating it if it does not already exist.
    Definition: An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType
  - addFormat
```
public DocumentReference addFormat(String theUri)
```
    Adds a new value for format (Format/content rules for the document)
    Definition: An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getSize
```
public IntegerDt getSize()
```
    Gets the value(s) for size (Size of the document in bytes). creating it if it does not exist. Will not return null.
    Definition: The size of the source document this reference refers to in bytes
  - setSize
```
public DocumentReference setSize(IntegerDt theValue)
```
    Sets the value(s) for size (Size of the document in bytes)
    Definition: The size of the source document this reference refers to in bytes
  - setSize
```
public DocumentReference setSize(int theInteger)
```
    Sets the value for size (Size of the document in bytes)
    Definition: The size of the source document this reference refers to in bytes
  - getHash
```
public StringDt getHash()
```
    Gets the value(s) for hash (HexBinary representation of SHA1). creating it if it does not exist. Will not return null.
    Definition: A hash of the source document to ensure that changes have not occurred
  - setHash
```
public DocumentReference setHash(StringDt theValue)
```
    Sets the value(s) for hash (HexBinary representation of SHA1)
    Definition: A hash of the source document to ensure that changes have not occurred
  - setHash
```
public DocumentReference setHash(String theString)
```
    Sets the value for hash (HexBinary representation of SHA1)
    Definition: A hash of the source document to ensure that changes have not occurred
  - getLocation
```
public UriDt getLocation()
```
    Gets the value(s) for location (Where to access the document). creating it if it does not exist. Will not return null.
    Definition: A url at which the document can be accessed
  - setLocation
```
public DocumentReference setLocation(UriDt theValue)
```
    Sets the value(s) for location (Where to access the document)
    Definition: A url at which the document can be accessed
  - setLocation
```
public DocumentReference setLocation(String theUri)
```
    Sets the value for location (Where to access the document)
    Definition: A url at which the document can be accessed
  - getService
```
public DocumentReference.Service getService()
```
    Gets the value(s) for service (If access is not fully described by location). creating it if it does not exist. Will not return null.
    Definition: A description of a service call that can be used to retrieve the document
  - setService
```
public DocumentReference setService(DocumentReference.Service theValue)
```
    Sets the value(s) for service (If access is not fully described by location)
    Definition: A description of a service call that can be used to retrieve the document
  - getContext
```
public DocumentReference.Context getContext()
```
    Gets the value(s) for context (Clinical context of document). creating it if it does not exist. Will not return null.
    Definition: The clinical context in which the document was prepared
  - setContext
```
public DocumentReference setContext(DocumentReference.Context theValue)
```
    Sets the value(s) for context (Clinical context of document)
    Definition: The clinical context in which the document was prepared

Class DocumentReference

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Field Detail

SP_IDENTIFIER

IDENTIFIER

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_TYPE

TYPE

SP_CLASS

CLASS

SP_AUTHOR

AUTHOR

INCLUDE_AUTHOR

SP_CUSTODIAN

CUSTODIAN

INCLUDE_CUSTODIAN

SP_AUTHENTICATOR

AUTHENTICATOR

INCLUDE_AUTHENTICATOR

SP_CREATED

CREATED

SP_INDEXED

INDEXED

SP_STATUS

STATUS

SP_RELATESTO

RELATESTO

INCLUDE_RELATESTO_TARGET

SP_RELATION

RELATION

SP_DESCRIPTION

DESCRIPTION

SP_CONFIDENTIALITY

CONFIDENTIALITY

SP_LANGUAGE

LANGUAGE

SP_FORMAT

FORMAT

SP_SIZE

SIZE

SP_LOCATION

LOCATION

SP_EVENT

EVENT

SP_PERIOD

PERIOD

SP_FACILITY

FACILITY

SP_RELATESTO_RELATION

RELATESTO_RELATION

Constructor Detail

DocumentReference

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getMasterIdentifier

setMasterIdentifier

setMasterIdentifier

setMasterIdentifier

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getSubject

setSubject

getType

setType

getClassElement