DocumentManifest (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.model.DocumentManifest

All Implemented Interfaces:

Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, IDomainResource
```
public class DocumentManifest
extends DomainResource
```
A manifest that defines a set of documents.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DocumentManifest.DocumentManifestContentComponent

static class DocumentManifest.DocumentManifestRelatedComponent

Nested Classes
Modifier and Type	Class and Description
`static class`	`DocumentManifest.DocumentManifestContentComponent`
`static class`	`DocumentManifest.DocumentManifestRelatedComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SP_AUTHOR`
`static String`	`SP_CONTENTREF`
`static String`	`SP_CREATED`
`static String`	`SP_DESCRIPTION`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_PATIENT`
`static String`	`SP_RECIPIENT`
`static String`	`SP_RELATEDID`
`static String`	`SP_RELATEDREF`
`static String`	`SP_SOURCE`
`static String`	`SP_STATUS`
`static String`	`SP_SUBJECT`
`static String`	`SP_TYPE`

Constructor Summary

Constructors
Constructor and Description

DocumentManifest()

DocumentManifest(Enumeration<Enumerations.DocumentReferenceStatus> status)

Constructors
Constructor and Description
`DocumentManifest()`
`DocumentManifest(Enumeration<Enumerations.DocumentReferenceStatus> status)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Reference`	`addAuthor()`
`DocumentManifest`	`addAuthor(Reference t)`
`DocumentManifest.DocumentManifestContentComponent`	`addContent()`
`DocumentManifest`	`addContent(DocumentManifest.DocumentManifestContentComponent t)`
`Identifier`	`addIdentifier()`
`DocumentManifest`	`addIdentifier(Identifier t)`
`Reference`	`addRecipient()`
`DocumentManifest`	`addRecipient(Reference t)`
`DocumentManifest.DocumentManifestRelatedComponent`	`addRelated()`
`DocumentManifest`	`addRelated(DocumentManifest.DocumentManifestRelatedComponent t)`
`DocumentManifest`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`List<Reference>`	`getAuthor()`
`List<Resource>`	`getAuthorTarget()`
`List<DocumentManifest.DocumentManifestContentComponent>`	`getContent()`
`Date`	`getCreated()`
`DateTimeType`	`getCreatedElement()`
`String`	`getDescription()`
`StringType`	`getDescriptionElement()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getMasterIdentifier()`
`List<Reference>`	`getRecipient()`
`List<Resource>`	`getRecipientTarget()`
`List<DocumentManifest.DocumentManifestRelatedComponent>`	`getRelated()`
`ResourceType`	`getResourceType()`
`String`	`getSource()`
`UriType`	`getSourceElement()`
`Enumerations.DocumentReferenceStatus`	`getStatus()`
`Enumeration<Enumerations.DocumentReferenceStatus>`	`getStatusElement()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`CodeableConcept`	`getType()`
`boolean`	`hasAuthor()`
`boolean`	`hasContent()`
`boolean`	`hasCreated()`
`boolean`	`hasCreatedElement()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasMasterIdentifier()`
`boolean`	`hasRecipient()`
`boolean`	`hasRelated()`
`boolean`	`hasSource()`
`boolean`	`hasSourceElement()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSubject()`
`boolean`	`hasType()`
`boolean`	`isEmpty()`
`DocumentManifest`	`setCreated(Date value)`
`DocumentManifest`	`setCreatedElement(DateTimeType value)`
`DocumentManifest`	`setDescription(String value)`
`DocumentManifest`	`setDescriptionElement(StringType value)`
`DocumentManifest`	`setMasterIdentifier(Identifier value)`
`DocumentManifest`	`setSource(String value)`
`DocumentManifest`	`setSourceElement(UriType value)`
`DocumentManifest`	`setStatus(Enumerations.DocumentReferenceStatus value)`
`DocumentManifest`	`setStatusElement(Enumeration<Enumerations.DocumentReferenceStatus> value)`
`DocumentManifest`	`setSubject(Reference value)`
`DocumentManifest`	`setSubjectTarget(Resource value)`
`DocumentManifest`	`setType(CodeableConcept value)`

Methods inherited from class org.hl7.fhir.instance.model.DomainResource
addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.instance.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.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasUserData, listChildrenByName, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getMeta, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
setId

- Field Detail
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_RELATEDID
```
public static final String SP_RELATEDID
```
    See Also:
    
    Constant Field Values
  - SP_CONTENTREF
```
public static final String SP_CONTENTREF
```
    See Also:
    
    Constant Field Values
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    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_DESCRIPTION
```
public static final String SP_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - SP_SOURCE
```
public static final String SP_SOURCE
```
    See Also:
    
    Constant Field Values
  - SP_TYPE
```
public static final String SP_TYPE
```
    See Also:
    
    Constant Field Values
  - SP_RELATEDREF
```
public static final String SP_RELATEDREF
```
    See Also:
    
    Constant Field Values
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    See Also:
    
    Constant Field Values
  - SP_RECIPIENT
```
public static final String SP_RECIPIENT
```
    See Also:
    
    Constant Field Values
  - SP_STATUS
```
public static final String SP_STATUS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DocumentManifest
```
public DocumentManifest()
```
  - DocumentManifest
```
public DocumentManifest(Enumeration<Enumerations.DocumentReferenceStatus> status)
```
- Method Detail
  - getMasterIdentifier
```
public Identifier getMasterIdentifier()
```
    Returns:
    
    masterIdentifier (A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.)
  - hasMasterIdentifier
```
public boolean hasMasterIdentifier()
```
  - setMasterIdentifier
```
public DocumentManifest setMasterIdentifier(Identifier value)
```
    Parameters:
    
    value - masterIdentifier (A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.)
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (Other identifiers associated with the document manifest, including version independent identifiers.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (Other identifiers associated with the document manifest, including version independent identifiers.)
  - addIdentifier
```
public DocumentManifest addIdentifier(Identifier t)
```
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. 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). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public DocumentManifest setSubject(Reference value)
```
    Parameters:
    
    value - subject (Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. 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). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).)
  - 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 set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. 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). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).)
  - setSubjectTarget
```
public DocumentManifest 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 set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. 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). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).)
  - getRecipient
```
public List<Reference> getRecipient()
```
    Returns:
    
    recipient (A patient, practitioner, or organization for which this set of documents is intended.)
  - hasRecipient
```
public boolean hasRecipient()
```
  - addRecipient
```
public Reference addRecipient()
```
    Returns:
    
    recipient (A patient, practitioner, or organization for which this set of documents is intended.)
  - addRecipient
```
public DocumentManifest addRecipient(Reference t)
```
  - getRecipientTarget
```
public List<Resource> getRecipientTarget()
```
    Returns:
    
    recipient (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. A patient, practitioner, or organization for which this set of documents is intended.)
  - getType
```
public CodeableConcept getType()
```
    Returns:
    
    type (Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.)
  - hasType
```
public boolean hasType()
```
  - setType
```
public DocumentManifest setType(CodeableConcept value)
```
    Parameters:
    
    value - type (Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.)
  - getAuthor
```
public List<Reference> getAuthor()
```
    Returns:
    
    author (Identifies who is responsible for creating the manifest, and adding documents to it.)
  - hasAuthor
```
public boolean hasAuthor()
```
  - addAuthor
```
public Reference addAuthor()
```
    Returns:
    
    author (Identifies who is responsible for creating the manifest, and adding documents to it.)
  - addAuthor
```
public DocumentManifest 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 creating the manifest, and adding documents to it.)
  - getCreatedElement
```
public DateTimeType getCreatedElement()
```
    Returns:
    
    created (When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).). 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 DocumentManifest setCreatedElement(DateTimeType value)
```
    Parameters:
    
    value - created (When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).). 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 manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
  - setCreated
```
public DocumentManifest setCreated(Date value)
```
    Parameters:
    
    value - When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
  - getSourceElement
```
public UriType getSourceElement()
```
    Returns:
    
    source (Identifies the source system, application, or software that produced the document manifest.). This is the underlying object with id, value and extensions. The accessor "getSource" gives direct access to the value
  - hasSourceElement
```
public boolean hasSourceElement()
```
  - hasSource
```
public boolean hasSource()
```
  - setSourceElement
```
public DocumentManifest setSourceElement(UriType value)
```
    Parameters:
    
    value - source (Identifies the source system, application, or software that produced the document manifest.). This is the underlying object with id, value and extensions. The accessor "getSource" gives direct access to the value
  - getSource
```
public String getSource()
```
    Returns:
    
    Identifies the source system, application, or software that produced the document manifest.
  - setSource
```
public DocumentManifest setSource(String value)
```
    Parameters:
    
    value - Identifies the source system, application, or software that produced the document manifest.
  - getStatusElement
```
public Enumeration<Enumerations.DocumentReferenceStatus> getStatusElement()
```
    Returns:
    
    status (The status of this document manifest.). 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 DocumentManifest setStatusElement(Enumeration<Enumerations.DocumentReferenceStatus> value)
```
    Parameters:
    
    value - status (The status of this document manifest.). 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 manifest.
  - setStatus
```
public DocumentManifest setStatus(Enumerations.DocumentReferenceStatus value)
```
    Parameters:
    
    value - The status of this document manifest.
  - 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 DocumentManifest 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 DocumentManifest setDescription(String value)
```
    Parameters:
    
    value - Human-readable description of the source document. This is sometimes known as the "title".
  - getContent
```
public List<DocumentManifest.DocumentManifestContentComponent> getContent()
```
    Returns:
    
    content (The list of Documents included in the manifest.)
  - hasContent
```
public boolean hasContent()
```
  - addContent
```
public DocumentManifest.DocumentManifestContentComponent addContent()
```
    Returns:
    
    content (The list of Documents included in the manifest.)
  - addContent
```
public DocumentManifest addContent(DocumentManifest.DocumentManifestContentComponent t)
```
  - getRelated
```
public List<DocumentManifest.DocumentManifestRelatedComponent> getRelated()
```
    Returns:
    
    related (Related identifiers or resources associated with the DocumentManifest.)
  - hasRelated
```
public boolean hasRelated()
```
  - addRelated
```
public DocumentManifest.DocumentManifestRelatedComponent addRelated()
```
    Returns:
    
    related (Related identifiers or resources associated with the DocumentManifest.)
  - addRelated
```
public DocumentManifest addRelated(DocumentManifest.DocumentManifestRelatedComponent t)
```
  - copy
```
public DocumentManifest copy()
```
    Specified by:
    
    copy in class DomainResource
  - 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 IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class DocumentManifest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

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

Field Detail

SP_IDENTIFIER

SP_RELATEDID

SP_CONTENTREF

SP_SUBJECT

SP_AUTHOR

SP_CREATED

SP_DESCRIPTION

SP_SOURCE

SP_TYPE

SP_RELATEDREF

SP_PATIENT

SP_RECIPIENT

SP_STATUS

Constructor Detail

DocumentManifest

DocumentManifest

Method Detail

getMasterIdentifier

hasMasterIdentifier

setMasterIdentifier

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getSubject

hasSubject

setSubject

getSubjectTarget

setSubjectTarget

getRecipient

hasRecipient

addRecipient

addRecipient

getRecipientTarget

getType

hasType

setType

getAuthor

hasAuthor

addAuthor

addAuthor

getAuthorTarget

getCreatedElement

hasCreatedElement

hasCreated

setCreatedElement

getCreated

setCreated

getSourceElement

hasSourceElement

hasSource

setSourceElement

getSource

setSource

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getDescriptionElement

hasDescriptionElement

hasDescription

setDescriptionElement

getDescription

setDescription

getContent