org.hl7.fhir.DocumentReference

All Implemented Interfaces:: org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2

public class DocumentReference extends DomainResource implements org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2

If the element is present, it must have either a @value, an @id, or extensions

Java class for DocumentReference complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="DocumentReference">
   <complexContent>
     <extension base="{http://hl7.org/fhir}DomainResource">
       <sequence>
         <element name="masterIdentifier" type="{http://hl7.org/fhir}Identifier" minOccurs="0"/>
         <element name="identifier" type="{http://hl7.org/fhir}Identifier" maxOccurs="unbounded" minOccurs="0"/>
         <element name="subject" type="{http://hl7.org/fhir}Reference" minOccurs="0"/>
         <element name="type" type="{http://hl7.org/fhir}CodeableConcept"/>
         <element name="class" type="{http://hl7.org/fhir}CodeableConcept" minOccurs="0"/>
         <element name="author" type="{http://hl7.org/fhir}Reference" maxOccurs="unbounded" minOccurs="0"/>
         <element name="custodian" type="{http://hl7.org/fhir}Reference" minOccurs="0"/>
         <element name="authenticator" type="{http://hl7.org/fhir}Reference" minOccurs="0"/>
         <element name="created" type="{http://hl7.org/fhir}dateTime" minOccurs="0"/>
         <element name="indexed" type="{http://hl7.org/fhir}instant"/>
         <element name="status" type="{http://hl7.org/fhir}DocumentReferenceStatus"/>
         <element name="docStatus" type="{http://hl7.org/fhir}CodeableConcept" minOccurs="0"/>
         <element name="relatesTo" type="{http://hl7.org/fhir}DocumentReference.RelatesTo" maxOccurs="unbounded" minOccurs="0"/>
         <element name="description" type="{http://hl7.org/fhir}string" minOccurs="0"/>
         <element name="securityLabel" type="{http://hl7.org/fhir}CodeableConcept" maxOccurs="unbounded" minOccurs="0"/>
         <element name="content" type="{http://hl7.org/fhir}DocumentReference.Content" maxOccurs="unbounded"/>
         <element name="context" type="{http://hl7.org/fhir}DocumentReference.Context" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

Field Summary

Fields

Modifier and Type

Field

Description

protected Reference

authenticator

protected List<Reference>

author

protected CodeableConcept

clazz

protected List<DocumentReferenceContent>

content

protected DocumentReferenceContext

context

protected DateTime

created

protected Reference

custodian

protected String

description

protected CodeableConcept

docStatus

protected List<Identifier>

identifier

protected Instant

indexed

protected Identifier

masterIdentifier

protected List<DocumentReferenceRelatesTo>

relatesTo

protected List<CodeableConcept>

securityLabel

protected DocumentReferenceStatus

status

protected Reference

subject

protected CodeableConcept

type

Fields inherited from class org.hl7.fhir.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.Resource
id, implicitRules, language, meta
Constructor Summary

Constructors

Constructor

Description

DocumentReference()
Method Summary

Modifier and Type

Method

Description

StringBuilder

append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)

StringBuilder

appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)

boolean

equals(Object object)

boolean

equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)

Reference

getAuthenticator()

Gets the value of the authenticator property.

List<Reference>

getAuthor()

Gets the value of the author property.

CodeableConcept

getClazz()

Gets the value of the clazz property.

List<DocumentReferenceContent>

getContent()

Gets the value of the content property.

DocumentReferenceContext

getContext()

Gets the value of the context property.

DateTime

getCreated()

Gets the value of the created property.

Reference

getCustodian()

Gets the value of the custodian property.

String

getDescription()

Gets the value of the description property.

CodeableConcept

getDocStatus()

Gets the value of the docStatus property.

List<Identifier>

getIdentifier()

Gets the value of the identifier property.

Instant

getIndexed()

Gets the value of the indexed property.

Identifier

getMasterIdentifier()

Gets the value of the masterIdentifier property.

List<DocumentReferenceRelatesTo>

getRelatesTo()

Gets the value of the relatesTo property.

List<CodeableConcept>

getSecurityLabel()

Gets the value of the securityLabel property.

DocumentReferenceStatus

getStatus()

Gets the value of the status property.

Reference

getSubject()

Gets the value of the subject property.

CodeableConcept

getType()

Gets the value of the type property.

int

hashCode()

int

hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)

void

setAuthenticator(Reference value)

Sets the value of the authenticator property.

void

setAuthor(List<Reference> value)

void

setClazz(CodeableConcept value)

Sets the value of the clazz property.

void

setContent(List<DocumentReferenceContent> value)

void

setContext(DocumentReferenceContext value)

Sets the value of the context property.

void

setCreated(DateTime value)

Sets the value of the created property.

void

setCustodian(Reference value)

Sets the value of the custodian property.

void

setDescription(String value)

Sets the value of the description property.

void

setDocStatus(CodeableConcept value)

Sets the value of the docStatus property.

void

setIdentifier(List<Identifier> value)

void

setIndexed(Instant value)

Sets the value of the indexed property.

void

setMasterIdentifier(Identifier value)

Sets the value of the masterIdentifier property.

void

setRelatesTo(List<DocumentReferenceRelatesTo> value)

void

setSecurityLabel(List<CodeableConcept> value)

void

setStatus(DocumentReferenceStatus value)

Sets the value of the status property.

void

setSubject(Reference value)

Sets the value of the subject property.

void

setType(CodeableConcept value)

Sets the value of the type property.

String

toString()

DocumentReference

withAuthenticator(Reference value)

DocumentReference

withAuthor(Collection<Reference> values)

DocumentReference

withAuthor(Reference... values)

DocumentReference

withClazz(CodeableConcept value)

DocumentReference

withContained(Collection<ResourceContainer> values)

DocumentReference

withContained(ResourceContainer... values)

DocumentReference

withContent(Collection<DocumentReferenceContent> values)

DocumentReference

withContent(DocumentReferenceContent... values)

DocumentReference

withContext(DocumentReferenceContext value)

DocumentReference

withCreated(DateTime value)

DocumentReference

withCustodian(Reference value)

DocumentReference

withDescription(String value)

DocumentReference

withDocStatus(CodeableConcept value)

DocumentReference

withExtension(Collection<Extension> values)

DocumentReference

withExtension(Extension... values)

DocumentReference

withId(Id value)

DocumentReference

withIdentifier(Collection<Identifier> values)

DocumentReference

withIdentifier(Identifier... values)

DocumentReference

withImplicitRules(Uri value)

DocumentReference

withIndexed(Instant value)

DocumentReference

withLanguage(Code value)

DocumentReference

withMasterIdentifier(Identifier value)

DocumentReference

withMeta(Meta value)

DocumentReference

withModifierExtension(Collection<Extension> values)

DocumentReference

withModifierExtension(Extension... values)

DocumentReference

withRelatesTo(Collection<DocumentReferenceRelatesTo> values)

DocumentReference

withRelatesTo(DocumentReferenceRelatesTo... values)

DocumentReference

withSecurityLabel(Collection<CodeableConcept> values)

DocumentReference

withSecurityLabel(CodeableConcept... values)

DocumentReference

withStatus(DocumentReferenceStatus value)

DocumentReference

withSubject(Reference value)

DocumentReference

withText(Narrative value)

DocumentReference

withType(CodeableConcept value)

Methods inherited from class org.hl7.fhir.DomainResource
getContained, getExtension, getModifierExtension, getText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.Resource
getId, getImplicitRules, getLanguage, getMeta, setId, setImplicitRules, setLanguage, setMeta

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

Field Details
- masterIdentifier
  
  protected Identifier masterIdentifier
- identifier
  
  protected List<Identifier> identifier
- subject
  
  protected Reference subject
- type
  
  protected CodeableConcept type
- clazz
  
  protected CodeableConcept clazz
- author
  
  protected List<Reference> author
- custodian
  
  protected Reference custodian
- authenticator
  
  protected Reference authenticator
- created
  
  protected DateTime created
- indexed
  
  protected Instant indexed
- status
  
  protected DocumentReferenceStatus status
- docStatus
  
  protected CodeableConcept docStatus
- relatesTo
  
  protected List<DocumentReferenceRelatesTo> relatesTo
- description
  
  protected String description
- securityLabel
  
  protected List<CodeableConcept> securityLabel
- content
  
  protected List<DocumentReferenceContent> content
- context
  
  protected DocumentReferenceContext context
Constructor Details
- DocumentReference
  
  public DocumentReference()
Method Details
- getMasterIdentifier
  
  public Identifier getMasterIdentifier()
  
  Gets the value of the masterIdentifier property.
  
  Returns:
  
  possible object is Identifier
- setMasterIdentifier
  
  public void setMasterIdentifier(Identifier value)
  
  Sets the value of the masterIdentifier property.
  
  Parameters:
  
  value - allowed object is Identifier
- getIdentifier
  
  public List<Identifier> getIdentifier()
  Gets the value of the identifier property.
  This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the identifier property.
  For example, to add a new item, do as follows:
  getIdentifier().add(newItem);
  
  Objects of the following type(s) are allowed in the list Identifier
- getSubject
  
  public Reference getSubject()
  
  Gets the value of the subject property.
  
  Returns:
  
  possible object is Reference
- setSubject
  
  public void setSubject(Reference value)
  
  Sets the value of the subject property.
  
  Parameters:
  
  value - allowed object is Reference
- getType
  
  public CodeableConcept getType()
  
  Gets the value of the type property.
  
  Returns:
  
  possible object is CodeableConcept
- setType
  
  public void setType(CodeableConcept value)
  
  Sets the value of the type property.
  
  Parameters:
  
  value - allowed object is CodeableConcept
- getClazz
  
  public CodeableConcept getClazz()
  
  Gets the value of the clazz property.
  
  Returns:
  
  possible object is CodeableConcept
- setClazz
  
  public void setClazz(CodeableConcept value)
  
  Sets the value of the clazz property.
  
  Parameters:
  
  value - allowed object is CodeableConcept
- getAuthor
  
  public List<Reference> getAuthor()
  Gets the value of the author property.
  This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the author property.
  For example, to add a new item, do as follows:
  getAuthor().add(newItem);
  
  Objects of the following type(s) are allowed in the list Reference
- getCustodian
  
  public Reference getCustodian()
  
  Gets the value of the custodian property.
  
  Returns:
  
  possible object is Reference
- setCustodian
  
  public void setCustodian(Reference value)
  
  Sets the value of the custodian property.
  
  Parameters:
  
  value - allowed object is Reference
- getAuthenticator
  
  public Reference getAuthenticator()
  
  Gets the value of the authenticator property.
  
  Returns:
  
  possible object is Reference
- setAuthenticator
  
  public void setAuthenticator(Reference value)
  
  Sets the value of the authenticator property.
  
  Parameters:
  
  value - allowed object is Reference
- getCreated
  
  public DateTime getCreated()
  
  Gets the value of the created property.
  
  Returns:
  
  possible object is DateTime
- setCreated
  
  public void setCreated(DateTime value)
  
  Sets the value of the created property.
  
  Parameters:
  
  value - allowed object is DateTime
- getIndexed
  
  public Instant getIndexed()
  
  Gets the value of the indexed property.
  
  Returns:
  
  possible object is Instant
- setIndexed
  
  public void setIndexed(Instant value)
  
  Sets the value of the indexed property.
  
  Parameters:
  
  value - allowed object is Instant
- getStatus
  
  public DocumentReferenceStatus getStatus()
  
  Gets the value of the status property.
  
  Returns:
  
  possible object is DocumentReferenceStatus
- setStatus
  
  public void setStatus(DocumentReferenceStatus value)
  
  Sets the value of the status property.
  
  Parameters:
  
  value - allowed object is DocumentReferenceStatus
- getDocStatus
  
  public CodeableConcept getDocStatus()
  
  Gets the value of the docStatus property.
  
  Returns:
  
  possible object is CodeableConcept
- setDocStatus
  
  public void setDocStatus(CodeableConcept value)
  
  Sets the value of the docStatus property.
  
  Parameters:
  
  value - allowed object is CodeableConcept
- getRelatesTo
  
  public List<DocumentReferenceRelatesTo> getRelatesTo()
  Gets the value of the relatesTo property.
  This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the relatesTo property.
  For example, to add a new item, do as follows:
  getRelatesTo().add(newItem);
  
  Objects of the following type(s) are allowed in the list DocumentReferenceRelatesTo
- getDescription
  
  public String getDescription()
  
  Gets the value of the description property.
  
  Returns:
  
  possible object is String
- setDescription
  
  public void setDescription(String value)
  
  Sets the value of the description property.
  
  Parameters:
  
  value - allowed object is String
- getSecurityLabel
  
  public List<CodeableConcept> getSecurityLabel()
  Gets the value of the securityLabel property.
  This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the securityLabel property.
  For example, to add a new item, do as follows:
  getSecurityLabel().add(newItem);
  
  Objects of the following type(s) are allowed in the list CodeableConcept
- getContent
  
  public List<DocumentReferenceContent> getContent()
  Gets the value of the content property.
  This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the content property.
  For example, to add a new item, do as follows:
  getContent().add(newItem);
  
  Objects of the following type(s) are allowed in the list DocumentReferenceContent
- getContext
  
  public DocumentReferenceContext getContext()
  
  Gets the value of the context property.
  
  Returns:
  
  possible object is DocumentReferenceContext
- setContext
  
  public void setContext(DocumentReferenceContext value)
  
  Sets the value of the context property.
  
  Parameters:
  
  value - allowed object is DocumentReferenceContext
- withMasterIdentifier
  
  public DocumentReference withMasterIdentifier(Identifier value)
- withIdentifier
  
  public DocumentReference withIdentifier(Identifier... values)
- withIdentifier
  
  public DocumentReference withIdentifier(Collection<Identifier> values)
- withSubject
  
  public DocumentReference withSubject(Reference value)
- withType
  
  public DocumentReference withType(CodeableConcept value)
- withClazz
  
  public DocumentReference withClazz(CodeableConcept value)
- withAuthor
  
  public DocumentReference withAuthor(Reference... values)
- withAuthor
  
  public DocumentReference withAuthor(Collection<Reference> values)
- withCustodian
  
  public DocumentReference withCustodian(Reference value)
- withAuthenticator
  
  public DocumentReference withAuthenticator(Reference value)
- withCreated
  
  public DocumentReference withCreated(DateTime value)
- withIndexed
  
  public DocumentReference withIndexed(Instant value)
- withStatus
  
  public DocumentReference withStatus(DocumentReferenceStatus value)
- withDocStatus
  
  public DocumentReference withDocStatus(CodeableConcept value)
- withRelatesTo
  
  public DocumentReference withRelatesTo(DocumentReferenceRelatesTo... values)
- withRelatesTo
  
  public DocumentReference withRelatesTo(Collection<DocumentReferenceRelatesTo> values)
- withDescription
  
  public DocumentReference withDescription(String value)
- withSecurityLabel
  
  public DocumentReference withSecurityLabel(CodeableConcept... values)
- withSecurityLabel
  
  public DocumentReference withSecurityLabel(Collection<CodeableConcept> values)
- withContent
  
  public DocumentReference withContent(DocumentReferenceContent... values)
- withContent
  
  public DocumentReference withContent(Collection<DocumentReferenceContent> values)
- withContext
  
  public DocumentReference withContext(DocumentReferenceContext value)
- withText
  
  public DocumentReference withText(Narrative value)
  
  Overrides:
  
  withText in class DomainResource
- withContained
  
  public DocumentReference withContained(ResourceContainer... values)
  
  Overrides:
  
  withContained in class DomainResource
- withContained
  
  public DocumentReference withContained(Collection<ResourceContainer> values)
  
  Overrides:
  
  withContained in class DomainResource
- withExtension
  
  public DocumentReference withExtension(Extension... values)
  
  Overrides:
  
  withExtension in class DomainResource
- withExtension
  
  public DocumentReference withExtension(Collection<Extension> values)
  
  Overrides:
  
  withExtension in class DomainResource
- withModifierExtension
  
  public DocumentReference withModifierExtension(Extension... values)
  
  Overrides:
  
  withModifierExtension in class DomainResource
- withModifierExtension
  
  public DocumentReference withModifierExtension(Collection<Extension> values)
  
  Overrides:
  
  withModifierExtension in class DomainResource
- withId
  
  public DocumentReference withId(Id value)
  
  Overrides:
  
  withId in class DomainResource
- withMeta
  
  public DocumentReference withMeta(Meta value)
  
  Overrides:
  
  withMeta in class DomainResource
- withImplicitRules
  
  public DocumentReference withImplicitRules(Uri value)
  
  Overrides:
  
  withImplicitRules in class DomainResource
- withLanguage
  
  public DocumentReference withLanguage(Code value)
  
  Overrides:
  
  withLanguage in class DomainResource
- equals
  
  public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)
  
  Specified by:
  
  equals in interface org.jvnet.jaxb2_commons.lang.Equals2
  
  Overrides:
  
  equals in class DomainResource
- equals
  
  public boolean equals(Object object)
  
  Overrides:
  
  equals in class DomainResource
- hashCode
  
  public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)
  
  Specified by:
  
  hashCode in interface org.jvnet.jaxb2_commons.lang.HashCode2
  
  Overrides:
  
  hashCode in class DomainResource
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class DomainResource
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class DomainResource
- append
  
  public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
  
  Specified by:
  
  append in interface org.jvnet.jaxb2_commons.lang.ToString2
  
  Overrides:
  
  append in class DomainResource
- appendFields
  
  public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
  
  Specified by:
  
  appendFields in interface org.jvnet.jaxb2_commons.lang.ToString2
  
  Overrides:
  
  appendFields in class DomainResource
- setIdentifier
  
  public void setIdentifier(List<Identifier> value)
- setAuthor
  
  public void setAuthor(List<Reference> value)
- setRelatesTo
  
  public void setRelatesTo(List<DocumentReferenceRelatesTo> value)
- setSecurityLabel
  
  public void setSecurityLabel(List<CodeableConcept> value)
- setContent
  
  public void setContent(List<DocumentReferenceContent> value)

Class DocumentReference

Field Summary

Fields inherited from class org.hl7.fhir.DomainResource

Fields inherited from class org.hl7.fhir.Resource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.DomainResource

Methods inherited from class org.hl7.fhir.Resource

Methods inherited from class java.lang.Object

Field Details

masterIdentifier

identifier

subject

type

clazz

author

custodian

authenticator

created

indexed

status

docStatus

relatesTo

description

securityLabel

content

context

Constructor Details

DocumentReference

Method Details

getMasterIdentifier

setMasterIdentifier

getIdentifier

getSubject

setSubject

getType

setType

getClazz

setClazz

getAuthor

getCustodian

setCustodian

getAuthenticator

setAuthenticator

getCreated

setCreated

getIndexed

setIndexed

getStatus

setStatus

getDocStatus

setDocStatus

getRelatesTo

getDescription

setDescription

getSecurityLabel

getContent

getContext

setContext

withMasterIdentifier

withIdentifier

withIdentifier

withSubject

withType

withClazz

withAuthor

withAuthor

withCustodian

withAuthenticator

withCreated

withIndexed

withStatus

withDocStatus

withRelatesTo

withRelatesTo

withDescription

withSecurityLabel

withSecurityLabel

withContent

withContent