Package org.hl7.fhir.dstu2.model

Class DocumentReference

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.BaseResource

org.hl7.fhir.dstu2.model.Resource

org.hl7.fhir.dstu2.model.DomainResource

org.hl7.fhir.dstu2.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 .

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentReference.DocumentReferenceContentComponent
static class	DocumentReference.DocumentReferenceContextComponent
static class	DocumentReference.DocumentReferenceContextRelatedComponent
static class	DocumentReference.DocumentReferenceRelatesToComponent
static enum	DocumentReference.DocumentRelationshipType
static class	DocumentReference.DocumentRelationshipTypeEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected Reference	authenticator	Which person or organization authenticates that this document is valid.
protected Resource	authenticatorTarget	The actual object that is the target of the reference (Which person or organization authenticates that this document is valid.)
protected List<Reference>	author	Identifies who is responsible for adding the information to the document.
protected List<Resource>	authorTarget	The actual objects that are the target of the reference (Identifies who is responsible for adding the information to the document.)
protected CodeableConcept	class_	A categorization for the type of document referenced - helps for indexing and searching.
protected List<DocumentReference.DocumentReferenceContentComponent>	content	The document and format referenced.
protected DocumentReference.DocumentReferenceContextComponent	context	The clinical context in which the document was prepared.
protected DateTimeType	created	When the document was created.
protected Reference	custodian	Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
protected Organization	custodianTarget	The actual object that is the target of the reference (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)
protected StringType	description	Human-readable description of the source document.
protected CodeableConcept	docStatus	The status of the underlying document.
protected List<Identifier>	identifier	Other identifiers associated with the document, including version independent identifiers.
protected InstantType	indexed	When the document reference was created.
protected Identifier	masterIdentifier	Document identifier as assigned by the source of the document.
protected List<DocumentReference.DocumentReferenceRelatesToComponent>	relatesTo	Relationships that this document has with other document references that already exist.
protected List<CodeableConcept>	securityLabel	A set of Security-Tag codes specifying the level of privacy/security of the Document.
static final String	SP_AUTHENTICATOR
static final String	SP_AUTHOR
static final String	SP_CLASS
static final String	SP_CREATED
static final String	SP_CUSTODIAN
static final String	SP_DESCRIPTION
static final String	SP_ENCOUNTER
static final String	SP_EVENT
static final String	SP_FACILITY
static final String	SP_FORMAT
static final String	SP_IDENTIFIER
static final String	SP_INDEXED
static final String	SP_LANGUAGE
static final String	SP_LOCATION
static final String	SP_PATIENT
static final String	SP_PERIOD
static final String	SP_RELATEDID
static final String	SP_RELATEDREF
static final String	SP_RELATESTO
static final String	SP_RELATION
static final String	SP_RELATIONSHIP
static final String	SP_SECURITYLABEL
static final String	SP_SETTING
static final String	SP_STATUS
static final String	SP_SUBJECT
static final String	SP_TYPE
protected Enumeration<Enumerations.DocumentReferenceStatus>	status	The status of this document reference.
protected Reference	subject	Who or what the document is about.
protected Resource	subjectTarget	The actual object that is the target of the reference (Who or what the document is about.
protected CodeableConcept	type	Specifies the particular kind of document referenced (e.g.

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
DocumentReference()
DocumentReference(CodeableConcept type, InstantType indexed, Enumeration<Enumerations.DocumentReferenceStatus> status)

Method Summary

Modifier and Type	Method	Description
Reference	addAuthor()
DocumentReference	addAuthor(Reference t)
Base	addChild(String name)
DocumentReference.DocumentReferenceContentComponent	addContent()
DocumentReference	addContent(DocumentReference.DocumentReferenceContentComponent t)
Identifier	addIdentifier()
DocumentReference	addIdentifier(Identifier t)
DocumentReference.DocumentReferenceRelatesToComponent	addRelatesTo()
DocumentReference	addRelatesTo(DocumentReference.DocumentReferenceRelatesToComponent t)
CodeableConcept	addSecurityLabel()
DocumentReference	addSecurityLabel(CodeableConcept t)
DocumentReference	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
Reference	getAuthenticator()
Resource	getAuthenticatorTarget()
List<Reference>	getAuthor()
List<Resource>	getAuthorTarget()
CodeableConcept	getClass_()
List<DocumentReference.DocumentReferenceContentComponent>	getContent()
DocumentReference.DocumentReferenceContextComponent	getContext()
Date	getCreated()
DateTimeType	getCreatedElement()
Reference	getCustodian()
Organization	getCustodianTarget()
String	getDescription()
StringType	getDescriptionElement()
CodeableConcept	getDocStatus()
List<Identifier>	getIdentifier()
Date	getIndexed()
InstantType	getIndexedElement()
Identifier	getMasterIdentifier()
List<DocumentReference.DocumentReferenceRelatesToComponent>	getRelatesTo()
ResourceType	getResourceType()
List<CodeableConcept>	getSecurityLabel()
Enumerations.DocumentReferenceStatus	getStatus()
Enumeration<Enumerations.DocumentReferenceStatus>	getStatusElement()
Reference	getSubject()
Resource	getSubjectTarget()
CodeableConcept	getType()
boolean	hasAuthenticator()
boolean	hasAuthor()
boolean	hasClass_()
boolean	hasContent()
boolean	hasContext()
boolean	hasCreated()
boolean	hasCreatedElement()
boolean	hasCustodian()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasDocStatus()
boolean	hasIdentifier()
boolean	hasIndexed()
boolean	hasIndexedElement()
boolean	hasMasterIdentifier()
boolean	hasRelatesTo()
boolean	hasSecurityLabel()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasType()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
DocumentReference	setAuthenticator(Reference value)
DocumentReference	setAuthenticatorTarget(Resource value)
DocumentReference	setClass_(CodeableConcept value)
DocumentReference	setContext(DocumentReference.DocumentReferenceContextComponent value)
DocumentReference	setCreated(Date value)
DocumentReference	setCreatedElement(DateTimeType value)
DocumentReference	setCustodian(Reference value)
DocumentReference	setCustodianTarget(Organization value)
DocumentReference	setDescription(String value)
DocumentReference	setDescriptionElement(StringType value)
DocumentReference	setDocStatus(CodeableConcept value)
DocumentReference	setIndexed(Date value)
DocumentReference	setIndexedElement(InstantType value)
DocumentReference	setMasterIdentifier(Identifier value)
void	setProperty(String name, Base value)
DocumentReference	setStatus(Enumerations.DocumentReferenceStatus value)
DocumentReference	setStatusElement(Enumeration<Enumerations.DocumentReferenceStatus> value)
DocumentReference	setSubject(Reference value)
DocumentReference	setSubjectTarget(Resource value)
DocumentReference	setType(CodeableConcept value)
protected DocumentReference	typedCopy()

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

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText

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

copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

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

getStructureFhirVersionEnum, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, 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

masterIdentifier

protected Identifier masterIdentifier

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.

identifier

protected List<Identifier> identifier

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

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).

subjectTarget

protected Resource subjectTarget

The actual object that is the target of the reference (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).)

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.

class_

protected CodeableConcept class_

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.

author

protected List<Reference> author

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

authorTarget

protected List<Resource> authorTarget

The actual objects that are the target of the reference (Identifies who is responsible for adding the information to the document.)

custodian

protected Reference custodian

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

custodianTarget

protected Organization custodianTarget

The actual object that is the target of the reference (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)

authenticator

protected Reference authenticator

Which person or organization authenticates that this document is valid.

authenticatorTarget

protected Resource authenticatorTarget

The actual object that is the target of the reference (Which person or organization authenticates that this document is valid.)

created

protected DateTimeType created

When the document was created.

indexed

protected InstantType indexed

When the document reference was created.

status

protected Enumeration<Enumerations.DocumentReferenceStatus> status

The status of this document reference.

docStatus

protected CodeableConcept docStatus

The status of the underlying document.

relatesTo

protected List<DocumentReference.DocumentReferenceRelatesToComponent> relatesTo

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

description

protected StringType description

Human-readable description of the source document. This is sometimes known as the "title".

securityLabel

protected List<CodeableConcept> securityLabel

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.

content

protected List<DocumentReference.DocumentReferenceContentComponent> content

The document and format referenced. There may be multiple content element repetitions, each with a different format.

context

protected DocumentReference.DocumentReferenceContextComponent context

The clinical context in which the document was prepared.

SP_SECURITYLABEL

public static final String SP_SECURITYLABEL

See Also:

• Constant Field Values

SP_SUBJECT

public static final String SP_SUBJECT

See Also:

• Constant Field Values

SP_DESCRIPTION

public static final String SP_DESCRIPTION

See Also:

• Constant Field Values

SP_LANGUAGE

public static final String SP_LANGUAGE

See Also:

• Constant Field Values

SP_TYPE

public static final String SP_TYPE

See Also:

• Constant Field Values

SP_RELATION

public static final String SP_RELATION

See Also:

• Constant Field Values

SP_SETTING

public static final String SP_SETTING

See Also:

• Constant Field Values

SP_PATIENT

public static final String SP_PATIENT

See Also:

• Constant Field Values

SP_RELATIONSHIP

public static final String SP_RELATIONSHIP

See Also:

• Constant Field Values

SP_EVENT

public static final String SP_EVENT

See Also:

• Constant Field Values

SP_CLASS

public static final String SP_CLASS

See Also:

• Constant Field Values

SP_AUTHENTICATOR

public static final String SP_AUTHENTICATOR

See Also:

• Constant Field Values

SP_IDENTIFIER

public static final String SP_IDENTIFIER

See Also:

• Constant Field Values

SP_PERIOD

public static final String SP_PERIOD

See Also:

• Constant Field Values

SP_RELATEDID

public static final String SP_RELATEDID

See Also:

• Constant Field Values

SP_CUSTODIAN

public static final String SP_CUSTODIAN

See Also:

• Constant Field Values

SP_INDEXED

public static final String SP_INDEXED

See Also:

• Constant Field Values

SP_AUTHOR

public static final String SP_AUTHOR

See Also:

• Constant Field Values

SP_CREATED

public static final String SP_CREATED

See Also:

• Constant Field Values

SP_FORMAT

public static final String SP_FORMAT

See Also:

• Constant Field Values

SP_ENCOUNTER

public static final String SP_ENCOUNTER

See Also:

• Constant Field Values

SP_RELATEDREF

public static final String SP_RELATEDREF

See Also:

• Constant Field Values

SP_LOCATION

public static final String SP_LOCATION

See Also:

• Constant Field Values

SP_RELATESTO

public static final String SP_RELATESTO

See Also:

• Constant Field Values

SP_FACILITY

public static final String SP_FACILITY

See Also:

• Constant Field Values

SP_STATUS

public static final String SP_STATUS

See Also:

• Constant Field Values

Constructor Details

DocumentReference

public DocumentReference()

DocumentReference

public DocumentReference(CodeableConcept type,
 InstantType indexed,
 Enumeration<Enumerations.DocumentReferenceStatus> status)

Method Details

getMasterIdentifier

public Identifier getMasterIdentifier()

Returns:

masterIdentifier (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.)

hasMasterIdentifier

public boolean hasMasterIdentifier()

setMasterIdentifier

public DocumentReference setMasterIdentifier(Identifier value)

Parameters:

value - masterIdentifier (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<Identifier> getIdentifier()

Returns:

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

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

Returns:

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

addIdentifier

public DocumentReference addIdentifier(Identifier t)

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).)

getSubjectTarget

public Resource getSubjectTarget()

Returns:

subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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).)

setSubjectTarget

public DocumentReference setSubjectTarget(Resource value)

Parameters:

value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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

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.)

getClass_

public CodeableConcept getClass_()

Returns:

class_ (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.)

hasClass_

public boolean hasClass_()

setClass_

public DocumentReference setClass_(CodeableConcept value)

Parameters:

value - class_ (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

public List<Reference> getAuthor()

Returns:

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

hasAuthor

public boolean hasAuthor()

addAuthor

public Reference addAuthor()

Returns:

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

addAuthor

public DocumentReference addAuthor(Reference t)

getAuthorTarget

public List<Resource> getAuthorTarget()

Returns:

author (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Identifies who is responsible for adding the information to the document.)

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.)

getCustodianTarget

public Organization getCustodianTarget()

Returns:

custodian The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)

setCustodianTarget

public DocumentReference setCustodianTarget(Organization value)

Parameters:

value - custodian The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.)

getAuthenticator

public Reference getAuthenticator()

Returns:

authenticator (Which person or organization authenticates that this document is valid.)

hasAuthenticator

public boolean hasAuthenticator()

setAuthenticator

public DocumentReference setAuthenticator(Reference value)

Parameters:

value - authenticator (Which person or organization authenticates that this document is valid.)

getAuthenticatorTarget

public Resource getAuthenticatorTarget()

Returns:

authenticator The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Which person or organization authenticates that this document is valid.)

setAuthenticatorTarget

public DocumentReference setAuthenticatorTarget(Resource value)

Parameters:

value - authenticator The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Which person or organization authenticates that this document is valid.)

getCreatedElement

public DateTimeType getCreatedElement()

Returns:

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

hasCreatedElement

public boolean hasCreatedElement()

hasCreated

public boolean hasCreated()

setCreatedElement

public DocumentReference setCreatedElement(DateTimeType value)

Parameters:

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

getCreated

public Date getCreated()

Returns:

When the document was created.

setCreated

public DocumentReference setCreated(Date value)

Parameters:

value - When the document was created.

getIndexedElement

public InstantType getIndexedElement()

Returns:

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

hasIndexedElement

public boolean hasIndexedElement()

hasIndexed

public boolean hasIndexed()

setIndexedElement

public DocumentReference setIndexedElement(InstantType value)

Parameters:

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

getIndexed

public Date getIndexed()

Returns:

When the document reference was created.

setIndexed

public DocumentReference setIndexed(Date value)

Parameters:

value - When the document reference was created.

getStatusElement

public Enumeration<Enumerations.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<Enumerations.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 Enumerations.DocumentReferenceStatus getStatus()

Returns:

The status of this document reference.

setStatus

public DocumentReference setStatus(Enumerations.DocumentReferenceStatus value)

Parameters:

value - The status of this document reference.

getDocStatus

public CodeableConcept getDocStatus()

Returns:

docStatus (The status of the underlying document.)

hasDocStatus

public boolean hasDocStatus()

setDocStatus

public DocumentReference setDocStatus(CodeableConcept value)

Parameters:

value - docStatus (The status of the underlying document.)

getRelatesTo

public List<DocumentReference.DocumentReferenceRelatesToComponent> getRelatesTo()

Returns:

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

hasRelatesTo

public boolean hasRelatesTo()

addRelatesTo

public DocumentReference.DocumentReferenceRelatesToComponent addRelatesTo()

Returns:

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

addRelatesTo

public DocumentReference addRelatesTo(DocumentReference.DocumentReferenceRelatesToComponent t)

getDescriptionElement

public StringType getDescriptionElement()

Returns:

description (Human-readable description of the source document. This is sometimes known as the "title".). 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(StringType value)

Parameters:

value - description (Human-readable description of the source document. This is sometimes known as the "title".). 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. This is sometimes known as the "title".

setDescription

public DocumentReference setDescription(String value)

Parameters:

value - Human-readable description of the source document. This is sometimes known as the "title".

getSecurityLabel

public List<CodeableConcept> getSecurityLabel()

Returns:

securityLabel (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.)

hasSecurityLabel

public boolean hasSecurityLabel()

addSecurityLabel

public CodeableConcept addSecurityLabel()

Returns:

securityLabel (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

public DocumentReference addSecurityLabel(CodeableConcept t)

getContent

public List<DocumentReference.DocumentReferenceContentComponent> getContent()

Returns:

content (The document and format referenced. There may be multiple content element repetitions, each with a different format.)

hasContent

public boolean hasContent()

addContent

public DocumentReference.DocumentReferenceContentComponent addContent()

Returns:

content (The document and format referenced. There may be multiple content element repetitions, each with a different format.)

addContent

public DocumentReference addContent(DocumentReference.DocumentReferenceContentComponent t)

getContext

public DocumentReference.DocumentReferenceContextComponent getContext()

Returns:

context (The clinical context in which the document was prepared.)

hasContext

public boolean hasContext()

setContext

public DocumentReference setContext(DocumentReference.DocumentReferenceContextComponent value)

Parameters:

value - context (The clinical context in which the document was prepared.)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

setProperty

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

Overrides:

setProperty 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

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