
Class DocumentReference
- All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement
,ca.uhn.fhir.model.api.IElement
,ca.uhn.fhir.model.api.IResource
,ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseResource
public class DocumentReference extends BaseResource implements ca.uhn.fhir.model.api.IResource
Definition: A reference to a document .
Requirements:
Profile Definition: http://hl7.org/fhir/profiles/DocumentReference
- See Also:
- Serialized Form
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DocumentReference.Content
Block class for child element: DocumentReference.content ()static class
DocumentReference.Context
Block class for child element: DocumentReference.context ()static class
DocumentReference.ContextRelated
Block class for child element: DocumentReference.context.related ()static class
DocumentReference.RelatesTo
Block class for child element: DocumentReference.relatesTo () -
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.ReferenceClientParam
AUTHENTICATOR
Fluent Client search parameter constant for authenticatorstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
AUTHOR
Fluent Client search parameter constant for authorstatic ca.uhn.fhir.rest.gclient.TokenClientParam
CLASS
Fluent Client search parameter constant for classstatic ca.uhn.fhir.rest.gclient.DateClientParam
CREATED
Fluent Client search parameter constant for createdstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
CUSTODIAN
Fluent Client search parameter constant for custodianstatic ca.uhn.fhir.rest.gclient.StringClientParam
DESCRIPTION
Fluent Client search parameter constant for descriptionstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
ENCOUNTER
Fluent Client search parameter constant for encounterstatic ca.uhn.fhir.rest.gclient.TokenClientParam
EVENT
Fluent Client search parameter constant for eventstatic ca.uhn.fhir.rest.gclient.TokenClientParam
FACILITY
Fluent Client search parameter constant for facilitystatic ca.uhn.fhir.rest.gclient.TokenClientParam
FORMAT
Fluent Client search parameter constant for formatstatic ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_AUTHENTICATOR
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_AUTHOR
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_CUSTODIAN
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_RELATED_REF
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_RELATESTO
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.DateClientParam
INDEXED
Fluent Client search parameter constant for indexedstatic ca.uhn.fhir.rest.gclient.TokenClientParam
LANGUAGE
Fluent Client search parameter constant for languagestatic ca.uhn.fhir.rest.gclient.UriClientParam
LOCATION
Fluent Client search parameter constant for locationstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientstatic ca.uhn.fhir.rest.gclient.DateClientParam
PERIOD
Fluent Client search parameter constant for periodstatic ca.uhn.fhir.rest.gclient.TokenClientParam
RELATED_ID
Fluent Client search parameter constant for related-idstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
RELATED_REF
Fluent Client search parameter constant for related-refstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
RELATESTO
Fluent Client search parameter constant for relatestostatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.ReferenceClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>
RELATESTO_RELATION
Fluent Client search parameter constant for relatesto-relationstatic ca.uhn.fhir.rest.gclient.TokenClientParam
RELATION
Fluent Client search parameter constant for relationstatic ca.uhn.fhir.rest.gclient.TokenClientParam
SECURITYLABEL
Fluent Client search parameter constant for securitylabelstatic ca.uhn.fhir.rest.gclient.TokenClientParam
SETTING
Fluent Client search parameter constant for settingstatic String
SP_AUTHENTICATOR
Search parameter constant for authenticatorstatic String
SP_AUTHOR
Search parameter constant for authorstatic String
SP_CLASS
Search parameter constant for classstatic String
SP_CREATED
Search parameter constant for createdstatic String
SP_CUSTODIAN
Search parameter constant for custodianstatic String
SP_DESCRIPTION
Search parameter constant for descriptionstatic String
SP_ENCOUNTER
Search parameter constant for encounterstatic String
SP_EVENT
Search parameter constant for eventstatic String
SP_FACILITY
Search parameter constant for facilitystatic String
SP_FORMAT
Search parameter constant for formatstatic String
SP_IDENTIFIER
Search parameter constant for identifierstatic String
SP_INDEXED
Search parameter constant for indexedstatic String
SP_LANGUAGE
Search parameter constant for languagestatic String
SP_LOCATION
Search parameter constant for locationstatic String
SP_PATIENT
Search parameter constant for patientstatic String
SP_PERIOD
Search parameter constant for periodstatic String
SP_RELATED_ID
Search parameter constant for related-idstatic String
SP_RELATED_REF
Search parameter constant for related-refstatic String
SP_RELATESTO
Search parameter constant for relatestostatic String
SP_RELATESTO_RELATION
Search parameter constant for relatesto-relationstatic String
SP_RELATION
Search parameter constant for relationstatic String
SP_SECURITYLABEL
Search parameter constant for securitylabelstatic String
SP_SETTING
Search parameter constant for settingstatic String
SP_STATUS
Search parameter constant for statusstatic String
SP_SUBJECT
Search parameter constant for subjectstatic String
SP_TYPE
Search parameter constant for typestatic ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
SUBJECT
Fluent Client search parameter constant for subjectstatic ca.uhn.fhir.rest.gclient.TokenClientParam
TYPE
Fluent Client search parameter constant for typeFields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
Constructors Constructor Description DocumentReference()
-
Method Summary
Modifier and Type Method Description ResourceReferenceDt
addAuthor()
Adds and returns a new value for author (who.author)DocumentReference.Content
addContent()
Adds and returns a new value for content ()DocumentReference
addContent(DocumentReference.Content theValue)
Adds a given new value for content ()IdentifierDt
addIdentifier()
Adds and returns a new value for identifier (id)DocumentReference
addIdentifier(IdentifierDt theValue)
Adds a given new value for identifier (id)DocumentReference.RelatesTo
addRelatesTo()
Adds and returns a new value for relatesTo ()DocumentReference
addRelatesTo(DocumentReference.RelatesTo theValue)
Adds a given new value for relatesTo ()CodeableConceptDt
addSecurityLabel()
Adds and returns a new value for securityLabel ()DocumentReference
addSecurityLabel(CodeableConceptDt theValue)
Adds a given new value for securityLabel ()<T extends ca.uhn.fhir.model.api.IElement>
List<T>getAllPopulatedChildElementsOfType(Class<T> theType)
ResourceReferenceDt
getAuthenticator()
Gets the value(s) for authenticator (who.witness).List<ResourceReferenceDt>
getAuthor()
Gets the value(s) for author (who.author).CodeableConceptDt
getClassElement()
Gets the value(s) for class (class).List<DocumentReference.Content>
getContent()
Gets the value(s) for content ().DocumentReference.Content
getContentFirstRep()
Gets the first repetition for content (), creating it if it does not already exist.DocumentReference.Context
getContext()
Gets the value(s) for context ().Date
getCreated()
Gets the value(s) for created (when.done).ca.uhn.fhir.model.primitive.DateTimeDt
getCreatedElement()
Gets the value(s) for created (when.done).ResourceReferenceDt
getCustodian()
Gets the value(s) for custodian ().String
getDescription()
Gets the value(s) for description ().ca.uhn.fhir.model.primitive.StringDt
getDescriptionElement()
Gets the value(s) for description ().CodeableConceptDt
getDocStatus()
Gets the value(s) for docStatus (status).List<IdentifierDt>
getIdentifier()
Gets the value(s) for identifier (id).IdentifierDt
getIdentifierFirstRep()
Gets the first repetition for identifier (id), creating it if it does not already exist.Date
getIndexed()
Gets the value(s) for indexed (when.recorded).ca.uhn.fhir.model.primitive.InstantDt
getIndexedElement()
Gets the value(s) for indexed (when.recorded).IdentifierDt
getMasterIdentifier()
Gets the value(s) for masterIdentifier (id).List<DocumentReference.RelatesTo>
getRelatesTo()
Gets the value(s) for relatesTo ().DocumentReference.RelatesTo
getRelatesToFirstRep()
Gets the first repetition for relatesTo (), creating it if it does not already exist.String
getResourceName()
List<CodeableConceptDt>
getSecurityLabel()
Gets the value(s) for securityLabel ().CodeableConceptDt
getSecurityLabelFirstRep()
Gets the first repetition for securityLabel (), creating it if it does not already exist.String
getStatus()
Gets the value(s) for status (status).ca.uhn.fhir.model.primitive.BoundCodeDt<DocumentReferenceStatusEnum>
getStatusElement()
Gets the value(s) for status (status).ca.uhn.fhir.context.FhirVersionEnum
getStructureFhirVersionEnum()
ResourceReferenceDt
getSubject()
Gets the value(s) for subject (who.focus).CodeableConceptDt
getType()
Gets the value(s) for type (class).boolean
isEmpty()
DocumentReference
setAuthenticator(ResourceReferenceDt theValue)
Sets the value(s) for authenticator (who.witness)DocumentReference
setAuthor(List<ResourceReferenceDt> theValue)
Sets the value(s) for author (who.author)DocumentReference
setClassElement(CodeableConceptDt theValue)
Sets the value(s) for class (class)DocumentReference
setContent(List<DocumentReference.Content> theValue)
Sets the value(s) for content ()DocumentReference
setContext(DocumentReference.Context theValue)
Sets the value(s) for context ()DocumentReference
setCreated(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
Sets the value(s) for created (when.done)DocumentReference
setCreated(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
Sets the value for created (when.done)DocumentReference
setCreatedWithSecondsPrecision(Date theDate)
Sets the value for created (when.done)DocumentReference
setCustodian(ResourceReferenceDt theValue)
Sets the value(s) for custodian ()DocumentReference
setDescription(ca.uhn.fhir.model.primitive.StringDt theValue)
Sets the value(s) for description ()DocumentReference
setDescription(String theString)
Sets the value for description ()DocumentReference
setDocStatus(CodeableConceptDt theValue)
Sets the value(s) for docStatus (status)DocumentReference
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (id)DocumentReference
setIndexed(ca.uhn.fhir.model.primitive.InstantDt theValue)
Sets the value(s) for indexed (when.recorded)DocumentReference
setIndexed(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
Sets the value for indexed (when.recorded)DocumentReference
setIndexedWithMillisPrecision(Date theDate)
Sets the value for indexed (when.recorded)DocumentReference
setMasterIdentifier(IdentifierDt theValue)
Sets the value(s) for masterIdentifier (id)DocumentReference
setRelatesTo(List<DocumentReference.RelatesTo> theValue)
Sets the value(s) for relatesTo ()DocumentReference
setSecurityLabel(List<CodeableConceptDt> theValue)
Sets the value(s) for securityLabel ()DocumentReference
setStatus(DocumentReferenceStatusEnum theValue)
Sets the value(s) for status (status)DocumentReference
setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<DocumentReferenceStatusEnum> theValue)
Sets the value(s) for status (status)DocumentReference
setSubject(ResourceReferenceDt theValue)
Sets the value(s) for subject (who.focus)DocumentReference
setType(CodeableConceptDt theValue)
Sets the value(s) for type (class)Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString
Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, setUserData
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId
Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata
-
Field Details
-
SP_IDENTIFIER
Search parameter constant for identifierDescription:
Type: token
Path: DocumentReference.masterIdentifier | DocumentReference.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription:
Type: token
Path: DocumentReference.masterIdentifier | DocumentReference.identifier
-
SP_SUBJECT
Search parameter constant for subjectDescription:
Type: reference
Path: DocumentReference.subject
- See Also:
- Constant Field Values
-
SUBJECT
Fluent Client search parameter constant for subjectDescription:
Type: reference
Path: DocumentReference.subject
-
SP_TYPE
Search parameter constant for typeDescription:
Type: token
Path: DocumentReference.type
- See Also:
- Constant Field Values
-
TYPE
Fluent Client search parameter constant for typeDescription:
Type: token
Path: DocumentReference.type
-
SP_CLASS
Search parameter constant for classDescription:
Type: token
Path: DocumentReference.class
- See Also:
- Constant Field Values
-
CLASS
Fluent Client search parameter constant for classDescription:
Type: token
Path: DocumentReference.class
-
SP_AUTHOR
Search parameter constant for authorDescription:
Type: reference
Path: DocumentReference.author
- See Also:
- Constant Field Values
-
AUTHOR
Fluent Client search parameter constant for authorDescription:
Type: reference
Path: DocumentReference.author
-
SP_CUSTODIAN
Search parameter constant for custodianDescription:
Type: reference
Path: DocumentReference.custodian
- See Also:
- Constant Field Values
-
CUSTODIAN
Fluent Client search parameter constant for custodianDescription:
Type: reference
Path: DocumentReference.custodian
-
SP_AUTHENTICATOR
Search parameter constant for authenticatorDescription:
Type: reference
Path: DocumentReference.authenticator
- See Also:
- Constant Field Values
-
AUTHENTICATOR
Fluent Client search parameter constant for authenticatorDescription:
Type: reference
Path: DocumentReference.authenticator
-
SP_CREATED
Search parameter constant for createdDescription:
Type: date
Path: DocumentReference.created
- See Also:
- Constant Field Values
-
CREATED
Fluent Client search parameter constant for createdDescription:
Type: date
Path: DocumentReference.created
-
SP_INDEXED
Search parameter constant for indexedDescription:
Type: date
Path: DocumentReference.indexed
- See Also:
- Constant Field Values
-
INDEXED
Fluent Client search parameter constant for indexedDescription:
Type: date
Path: DocumentReference.indexed
-
SP_STATUS
Search parameter constant for statusDescription:
Type: token
Path: DocumentReference.status
- See Also:
- Constant Field Values
-
STATUS
Fluent Client search parameter constant for statusDescription:
Type: token
Path: DocumentReference.status
-
SP_RELATESTO
Search parameter constant for relatestoDescription:
Type: reference
Path: DocumentReference.relatesTo.target
- See Also:
- Constant Field Values
-
RELATESTO
Fluent Client search parameter constant for relatestoDescription:
Type: reference
Path: DocumentReference.relatesTo.target
-
SP_RELATION
Search parameter constant for relationDescription:
Type: token
Path: DocumentReference.relatesTo.code
- See Also:
- Constant Field Values
-
RELATION
Fluent Client search parameter constant for relationDescription:
Type: token
Path: DocumentReference.relatesTo.code
-
SP_DESCRIPTION
Search parameter constant for descriptionDescription:
Type: string
Path: DocumentReference.description
- See Also:
- Constant Field Values
-
DESCRIPTION
Fluent Client search parameter constant for descriptionDescription:
Type: string
Path: DocumentReference.description
-
SP_SECURITYLABEL
Search parameter constant for securitylabelDescription:
Type: token
Path: DocumentReference.securityLabel
- See Also:
- Constant Field Values
-
SECURITYLABEL
Fluent Client search parameter constant for securitylabelDescription:
Type: token
Path: DocumentReference.securityLabel
-
SP_FORMAT
Search parameter constant for formatDescription:
Type: token
Path: DocumentReference.content.format
- See Also:
- Constant Field Values
-
FORMAT
Fluent Client search parameter constant for formatDescription:
Type: token
Path: DocumentReference.content.format
-
SP_LANGUAGE
Search parameter constant for languageDescription:
Type: token
Path: DocumentReference.content.attachment.language
- See Also:
- Constant Field Values
-
LANGUAGE
Fluent Client search parameter constant for languageDescription:
Type: token
Path: DocumentReference.content.attachment.language
-
SP_LOCATION
Search parameter constant for locationDescription:
Type: uri
Path: DocumentReference.content.attachment.url
- See Also:
- Constant Field Values
-
LOCATION
Fluent Client search parameter constant for locationDescription:
Type: uri
Path: DocumentReference.content.attachment.url
-
SP_EVENT
Search parameter constant for eventDescription:
Type: token
Path: DocumentReference.context.event
- See Also:
- Constant Field Values
-
EVENT
Fluent Client search parameter constant for eventDescription:
Type: token
Path: DocumentReference.context.event
-
SP_PERIOD
Search parameter constant for periodDescription:
Type: date
Path: DocumentReference.context.period
- See Also:
- Constant Field Values
-
PERIOD
Fluent Client search parameter constant for periodDescription:
Type: date
Path: DocumentReference.context.period
-
SP_FACILITY
Search parameter constant for facilityDescription:
Type: token
Path: DocumentReference.context.facilityType
- See Also:
- Constant Field Values
-
FACILITY
Fluent Client search parameter constant for facilityDescription:
Type: token
Path: DocumentReference.context.facilityType
-
SP_PATIENT
Search parameter constant for patientDescription:
Type: reference
Path: DocumentReference.subject
- See Also:
- Constant Field Values
-
PATIENT
Fluent Client search parameter constant for patientDescription:
Type: reference
Path: DocumentReference.subject
-
SP_SETTING
Search parameter constant for settingDescription:
Type: token
Path: DocumentReference.context.practiceSetting
- See Also:
- Constant Field Values
-
SETTING
Fluent Client search parameter constant for settingDescription:
Type: token
Path: DocumentReference.context.practiceSetting
-
SP_RELATED_ID
Search parameter constant for related-idDescription:
Type: token
Path: DocumentReference.context.related.identifier
- See Also:
- Constant Field Values
-
RELATED_ID
Fluent Client search parameter constant for related-idDescription:
Type: token
Path: DocumentReference.context.related.identifier
-
SP_RELATED_REF
Search parameter constant for related-refDescription:
Type: reference
Path: DocumentReference.context.related.ref
- See Also:
- Constant Field Values
-
RELATED_REF
Fluent Client search parameter constant for related-refDescription:
Type: reference
Path: DocumentReference.context.related.ref
-
SP_ENCOUNTER
Search parameter constant for encounterDescription:
Type: reference
Path: DocumentReference.context.encounter
- See Also:
- Constant Field Values
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription:
Type: reference
Path: DocumentReference.context.encounter
-
SP_RELATESTO_RELATION
Search parameter constant for relatesto-relationDescription: Combination of relation and relatesTo
Type: composite
Path: relatesto & relation
- See Also:
- Constant Field Values
-
RELATESTO_RELATION
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.ReferenceClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> RELATESTO_RELATIONFluent Client search parameter constant for relatesto-relationDescription: Combination of relation and relatesTo
Type: composite
Path: relatesto & relation
-
INCLUDE_AUTHENTICATOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:authenticator". -
INCLUDE_AUTHOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:author". -
INCLUDE_CUSTODIAN
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:custodian". -
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:encounter". -
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:patient". -
INCLUDE_RELATED_REF
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:related-ref". -
INCLUDE_RELATESTO
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:relatesto". -
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentReference:subject".
-
-
Constructor Details
-
DocumentReference
public DocumentReference()
-
-
Method Details
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
-
getAllPopulatedChildElementsOfType
public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)- Specified by:
getAllPopulatedChildElementsOfType
in interfaceca.uhn.fhir.model.api.ICompositeElement
-
getMasterIdentifier
Gets the value(s) for masterIdentifier (id). creating it if it does not exist. Will not returnnull
.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
Sets the value(s) for masterIdentifier (id)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
Gets the value(s) for identifier (id). creating it if it does not exist. Will not returnnull
.Definition: Other identifiers associated with the document, including version independent identifiers
-
setIdentifier
Sets the value(s) for identifier (id)Definition: Other identifiers associated with the document, including version independent identifiers
-
addIdentifier
Adds and returns a new value for identifier (id)Definition: Other identifiers associated with the document, including version independent identifiers
-
addIdentifier
Adds a given new value for identifier (id)Definition: Other identifiers associated with the document, including version independent identifiers
- Parameters:
theValue
- The identifier to add (must not benull
)
-
getIdentifierFirstRep
Gets the first repetition for identifier (id), creating it if it does not already exist.Definition: Other identifiers associated with the document, including version independent identifiers
-
getSubject
Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not returnnull
.Definition: 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)
-
setSubject
Sets the value(s) for subject (who.focus)Definition: 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)
-
getType
Gets the value(s) for type (class). creating it if it does not exist. Will not returnnull
.Definition: 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.
-
setType
Sets the value(s) for type (class)Definition: 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.
-
getClassElement
Gets the value(s) for class (class). creating it if it does not exist. Will not returnnull
.Definition: 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
-
setClassElement
Sets the value(s) for class (class)Definition: 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
-
getAuthor
Gets the value(s) for author (who.author). creating it if it does not exist. Will not returnnull
.Definition: Identifies who is responsible for adding the information to the document
-
setAuthor
Sets the value(s) for author (who.author)Definition: Identifies who is responsible for adding the information to the document
-
addAuthor
Adds and returns a new value for author (who.author)Definition: Identifies who is responsible for adding the information to the document
-
getCustodian
Gets the value(s) for custodian (). creating it if it does not exist. Will not returnnull
.Definition: Identifies the organization or group who is responsible for ongoing maintenance of and access to the document
-
setCustodian
Sets the value(s) for custodian ()Definition: Identifies the organization or group who is responsible for ongoing maintenance of and access to the document
-
getAuthenticator
Gets the value(s) for authenticator (who.witness). creating it if it does not exist. Will not returnnull
.Definition: Which person or organization authenticates that this document is valid
-
setAuthenticator
Sets the value(s) for authenticator (who.witness)Definition: Which person or organization authenticates that this document is valid
-
getCreatedElement
Gets the value(s) for created (when.done). creating it if it does not exist. Will not returnnull
.Definition: When the document was created
-
getCreated
Gets the value(s) for created (when.done). creating it if it does not exist. This method may returnnull
.Definition: When the document was created
-
setCreated
Sets the value(s) for created (when.done)Definition: When the document was created
-
setCreated
public DocumentReference setCreated(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)Sets the value for created (when.done)Definition: When the document was created
-
setCreatedWithSecondsPrecision
Sets the value for created (when.done)Definition: When the document was created
-
getIndexedElement
Gets the value(s) for indexed (when.recorded). creating it if it does not exist. Will not returnnull
.Definition: When the document reference was created
-
getIndexed
Gets the value(s) for indexed (when.recorded). creating it if it does not exist. This method may returnnull
.Definition: When the document reference was created
-
setIndexed
Sets the value(s) for indexed (when.recorded)Definition: When the document reference was created
-
setIndexedWithMillisPrecision
Sets the value for indexed (when.recorded)Definition: When the document reference was created
-
setIndexed
public DocumentReference setIndexed(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)Sets the value for indexed (when.recorded)Definition: When the document reference was created
-
getStatusElement
Gets the value(s) for status (status). creating it if it does not exist. Will not returnnull
.Definition: The status of this document reference
-
getStatus
Gets the value(s) for status (status). creating it if it does not exist. This method may returnnull
.Definition: The status of this document reference
-
setStatus
public DocumentReference setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<DocumentReferenceStatusEnum> theValue)Sets the value(s) for status (status)Definition: The status of this document reference
-
setStatus
Sets the value(s) for status (status)Definition: The status of this document reference
-
getDocStatus
Gets the value(s) for docStatus (status). creating it if it does not exist. Will not returnnull
.Definition: The status of the underlying document
-
setDocStatus
Sets the value(s) for docStatus (status)Definition: The status of the underlying document
-
getRelatesTo
Gets the value(s) for relatesTo (). creating it if it does not exist. Will not returnnull
.Definition: Relationships that this document has with other document references that already exist
-
setRelatesTo
Sets the value(s) for relatesTo ()Definition: Relationships that this document has with other document references that already exist
-
addRelatesTo
Adds and returns a new value for relatesTo ()Definition: Relationships that this document has with other document references that already exist
-
addRelatesTo
Adds a given new value for relatesTo ()Definition: Relationships that this document has with other document references that already exist
- Parameters:
theValue
- The relatesTo to add (must not benull
)
-
getRelatesToFirstRep
Gets the first repetition for relatesTo (), creating it if it does not already exist.Definition: Relationships that this document has with other document references that already exist
-
getDescriptionElement
Gets the value(s) for description (). creating it if it does not exist. Will not returnnull
.Definition: Human-readable description of the source document. This is sometimes known as the \"title\"
-
getDescription
Gets the value(s) for description (). creating it if it does not exist. This method may returnnull
.Definition: Human-readable description of the source document. This is sometimes known as the \"title\"
-
setDescription
Sets the value(s) for description ()Definition: Human-readable description of the source document. This is sometimes known as the \"title\"
-
setDescription
Sets the value for description ()Definition: Human-readable description of the source document. This is sometimes known as the \"title\"
-
getSecurityLabel
Gets the value(s) for securityLabel (). creating it if it does not exist. Will not returnnull
.Definition: A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the \"reference\" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to
-
setSecurityLabel
Sets the value(s) for securityLabel ()Definition: A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the \"reference\" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to
-
addSecurityLabel
Adds and returns a new value for securityLabel ()Definition: A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the \"reference\" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to
-
addSecurityLabel
Adds a given new value for securityLabel ()Definition: A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the \"reference\" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to
- Parameters:
theValue
- The securityLabel to add (must not benull
)
-
getSecurityLabelFirstRep
Gets the first repetition for securityLabel (), creating it if it does not already exist.Definition: A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the \"reference\" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to
-
getContent
Gets the value(s) for content (). creating it if it does not exist. Will not returnnull
.Definition: The document and format referenced. There may be multiple content element repetitions, each with a different format.
-
setContent
Sets the value(s) for content ()Definition: The document and format referenced. There may be multiple content element repetitions, each with a different format.
-
addContent
Adds and returns a new value for content ()Definition: The document and format referenced. There may be multiple content element repetitions, each with a different format.
-
addContent
Adds a given new value for content ()Definition: The document and format referenced. There may be multiple content element repetitions, each with a different format.
- Parameters:
theValue
- The content to add (must not benull
)
-
getContentFirstRep
Gets the first repetition for content (), creating it if it does not already exist.Definition: The document and format referenced. There may be multiple content element repetitions, each with a different format.
-
getContext
Gets the value(s) for context (). creating it if it does not exist. Will not returnnull
.Definition: The clinical context in which the document was prepared
-
setContext
Sets the value(s) for context ()Definition: The clinical context in which the document was prepared
-
getResourceName
- Specified by:
getResourceName
in interfaceca.uhn.fhir.model.api.IResource
-
getStructureFhirVersionEnum
- Specified by:
getStructureFhirVersionEnum
in interfaceorg.hl7.fhir.instance.model.api.IBaseResource
- Specified by:
getStructureFhirVersionEnum
in interfaceca.uhn.fhir.model.api.IResource
-