Package com.ibm.fhir.model.resource

Class DocumentReference

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.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)

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

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

      • getDescription

        public String getDescription()
        Human-readable description of the source document.
        Returns:
        An immutable object of type String that may be null.

      • getSecurityLabel

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

      • accept

        public void accept​(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 interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object