Class DocumentReference
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.DocumentReference
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class DocumentReference extends DomainResource
A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.Maturity level: FMM3 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DocumentReference.Builder
static class
DocumentReference.Content
The document and format referenced.static class
DocumentReference.Context
The clinical context in which the document was prepared.static class
DocumentReference.RelatesTo
Relationships that this document has with other document references that already exist.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static DocumentReference.Builder
builder()
boolean
equals(java.lang.Object obj)
Reference
getAuthenticator()
Which person or organization authenticates that this document is valid.java.util.List<Reference>
getAuthor()
Identifies who is responsible for adding the information to the document.java.util.List<CodeableConcept>
getCategory()
A categorization for the type of document referenced - helps for indexing and searching.java.util.List<DocumentReference.Content>
getContent()
The document and format referenced.DocumentReference.Context
getContext()
The clinical context in which the document was prepared.Reference
getCustodian()
Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.Instant
getDate()
When the document reference was created.String
getDescription()
Human-readable description of the source document.ReferredDocumentStatus
getDocStatus()
The status of the underlying document.java.util.List<Identifier>
getIdentifier()
Other identifiers associated with the document, including version independent identifiers.Identifier
getMasterIdentifier()
Document identifier as assigned by the source of the document.java.util.List<DocumentReference.RelatesTo>
getRelatesTo()
Relationships that this document has with other document references that already exist.java.util.List<CodeableConcept>
getSecurityLabel()
A set of Security-Tag codes specifying the level of privacy/security of the Document.DocumentReferenceStatus
getStatus()
The status of this document reference.Reference
getSubject()
Who or what the document is about.CodeableConcept
getType()
Specifies the particular kind of document referenced (e.g.boolean
hasChildren()
int
hashCode()
DocumentReference.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getMasterIdentifier
public Identifier getMasterIdentifier()
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.- Returns:
- An immutable object of type
Identifier
that may be null.
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
Other identifiers associated with the document, including version independent identifiers.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getStatus
public DocumentReferenceStatus getStatus()
The status of this document reference.- Returns:
- An immutable object of type
DocumentReferenceStatus
that is non-null.
-
getDocStatus
public ReferredDocumentStatus getDocStatus()
The status of the underlying document.- Returns:
- An immutable object of type
ReferredDocumentStatus
that may be null.
-
getType
public CodeableConcept getType()
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.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getCategory
public java.util.List<CodeableConcept> getCategory()
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.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getSubject
public Reference getSubject()
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).- Returns:
- An immutable object of type
Reference
that may be null.
-
getDate
public Instant getDate()
When the document reference was created.- Returns:
- An immutable object of type
Instant
that may be null.
-
getAuthor
public java.util.List<Reference> getAuthor()
Identifies who is responsible for adding the information to the document.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getAuthenticator
public Reference getAuthenticator()
Which person or organization authenticates that this document is valid.- Returns:
- An immutable object of type
Reference
that may be null.
-
getCustodian
public Reference getCustodian()
Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.- Returns:
- An immutable object of type
Reference
that may be null.
-
getRelatesTo
public java.util.List<DocumentReference.RelatesTo> getRelatesTo()
Relationships that this document has with other document references that already exist.- Returns:
- An unmodifiable list containing immutable objects of type
DocumentReference.RelatesTo
that may be empty.
-
getDescription
public String getDescription()
Human-readable description of the source document.- Returns:
- An immutable object of type
String
that may be null.
-
getSecurityLabel
public java.util.List<CodeableConcept> getSecurityLabel()
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.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getContent
public java.util.List<DocumentReference.Content> getContent()
The document and format referenced. There may be multiple content element repetitions, each with a different format.- Returns:
- An unmodifiable list containing immutable objects of type
DocumentReference.Content
that is non-empty.
-
getContext
public DocumentReference.Context getContext()
The clinical context in which the document was prepared.- Returns:
- An immutable object of type
DocumentReference.Context
that may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public DocumentReference.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static DocumentReference.Builder builder()
-
-