DocumentManifest (HAPI FHIR Structures

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

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 DocumentManifest
extends DomainResource
```
A collection of documents compiled for a purpose together with metadata that applies to the collection.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DocumentManifest.DocumentManifestAgentComponent

static class DocumentManifest.DocumentManifestRelatedComponent

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<DocumentManifest.DocumentManifestAgentComponent>`	`agent` An actor taking an active role in the manifest.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`AGENT` Fluent Client search parameter constant for agent
`protected List<Reference>`	`content` The list of Resources that consist of the parts of this manifest.
`protected List<Resource>`	`contentTarget` The actual objects that are the target of the reference (The list of Resources that consist of the parts of this manifest.)
`protected DateTimeType`	`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.).
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`CREATED` Fluent Client search parameter constant for created
`protected StringType`	`description` Human-readable description of the source document.
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`DESCRIPTION` Fluent Client search parameter constant for description
`protected List<Identifier>`	`identifier` Other identifiers associated with the document manifest, including version independent identifiers.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_AGENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ITEM` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_RECIPIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_RELATED_REF` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ITEM` Fluent Client search parameter constant for item
`protected Identifier`	`masterIdentifier` A single identifier that uniquely identifies this manifest.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`protected List<Reference>`	`recipient` A patient, practitioner, or organization for which this set of documents is intended.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`RECIPIENT` Fluent Client search parameter constant for recipient
`protected List<Resource>`	`recipientTarget` The actual objects that are the target of the reference (A patient, practitioner, or organization for which this set of documents is intended.)
`protected List<DocumentManifest.DocumentManifestRelatedComponent>`	`related` Related identifiers or resources associated with the DocumentManifest.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`RELATED_ID` Fluent Client search parameter constant for related-id
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`RELATED_REF` Fluent Client search parameter constant for related-ref
`protected UriType`	`source` Identifies the source system, application, or software that produced the document manifest.
`static ca.uhn.fhir.rest.gclient.UriClientParam`	`SOURCE` Fluent Client search parameter constant for source
`static String`	`SP_AGENT` Search parameter: agent
`static String`	`SP_CREATED` Search parameter: created
`static String`	`SP_DESCRIPTION` Search parameter: description
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_ITEM` Search parameter: item
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_RECIPIENT` Search parameter: recipient
`static String`	`SP_RELATED_ID` Search parameter: related-id
`static String`	`SP_RELATED_REF` Search parameter: related-ref
`static String`	`SP_SOURCE` Search parameter: source
`static String`	`SP_STATUS` Search parameter: status
`static String`	`SP_SUBJECT` Search parameter: subject
`static String`	`SP_TYPE` Search parameter: type
`protected Enumeration<Enumerations.DocumentReferenceStatus>`	`status` The status of this document manifest.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`protected Reference`	`subject` Who or what the set of documents is about.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`protected Resource`	`subjectTarget` The actual object that is the target of the reference (Who or what the set of documents is about.
`protected CodeableConcept`	`type` The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

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

Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

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

Constructor Summary

Constructors
Constructor and Description

DocumentManifest()
Constructor

DocumentManifest(Enumeration<Enumerations.DocumentReferenceStatus> status)
Constructor

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DocumentManifest.DocumentManifestAgentComponent`	`addAgent()`
`DocumentManifest`	`addAgent(DocumentManifest.DocumentManifestAgentComponent t)`
`Base`	`addChild(String name)`
`Reference`	`addContent()`
`DocumentManifest`	`addContent(Reference 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_)`
`String`	`fhirType()`
`List<DocumentManifest.DocumentManifestAgentComponent>`	`getAgent()`
`DocumentManifest.DocumentManifestAgentComponent`	`getAgentFirstRep()`
`List<Reference>`	`getContent()`
`Reference`	`getContentFirstRep()`
`List<Resource>`	`getContentTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Date`	`getCreated()`
`DateTimeType`	`getCreatedElement()`
`String`	`getDescription()`
`StringType`	`getDescriptionElement()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`Identifier`	`getMasterIdentifier()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<Reference>`	`getRecipient()`
`Reference`	`getRecipientFirstRep()`
`List<Resource>`	`getRecipientTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`List<DocumentManifest.DocumentManifestRelatedComponent>`	`getRelated()`
`DocumentManifest.DocumentManifestRelatedComponent`	`getRelatedFirstRep()`
`ResourceType`	`getResourceType()`
`String`	`getSource()`
`UriType`	`getSourceElement()`
`Enumerations.DocumentReferenceStatus`	`getStatus()`
`Enumeration<Enumerations.DocumentReferenceStatus>`	`getStatusElement()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`CodeableConcept`	`getType()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasAgent()`
`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()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`DocumentManifest`	`setAgent(List<DocumentManifest.DocumentManifestAgentComponent> theAgent)`
`DocumentManifest`	`setContent(List<Reference> theContent)`
`DocumentManifest`	`setCreated(Date value)`
`DocumentManifest`	`setCreatedElement(DateTimeType value)`
`DocumentManifest`	`setDescription(String value)`
`DocumentManifest`	`setDescriptionElement(StringType value)`
`DocumentManifest`	`setIdentifier(List<Identifier> theIdentifier)`
`DocumentManifest`	`setMasterIdentifier(Identifier value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`DocumentManifest`	`setRecipient(List<Reference> theRecipient)`
`DocumentManifest`	`setRelated(List<DocumentManifest.DocumentManifestRelatedComponent> theRelated)`
`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)`
`protected DocumentManifest`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, 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.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - masterIdentifier
```
protected Identifier masterIdentifier
```
    A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
  - identifier
```
protected List<Identifier> identifier
```
    Other identifiers associated with the document manifest, including version independent identifiers.
  - status
```
protected Enumeration<Enumerations.DocumentReferenceStatus> status
```
    The status of this document manifest.
  - type
```
protected CodeableConcept type
```
    The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
  - subject
```
protected Reference 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).
  - subjectTarget
```
protected Resource subjectTarget
```
    The actual object that is the target of the reference (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).)
  - created
```
protected DateTimeType 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.).
  - agent
```
protected List<DocumentManifest.DocumentManifestAgentComponent> agent
```
    An actor taking an active role in the manifest.
  - recipient
```
protected List<Reference> recipient
```
    A patient, practitioner, or organization for which this set of documents is intended.
  - recipientTarget
```
protected List<Resource> recipientTarget
```
    The actual objects that are the target of the reference (A patient, practitioner, or organization for which this set of documents is intended.)
  - source
```
protected UriType source
```
    Identifies the source system, application, or software that produced the document manifest.
  - description
```
protected StringType description
```
    Human-readable description of the source document. This is sometimes known as the "title".
  - content
```
protected List<Reference> content
```
    The list of Resources that consist of the parts of this manifest.
  - contentTarget
```
protected List<Resource> contentTarget
```
    The actual objects that are the target of the reference (The list of Resources that consist of the parts of this manifest.)
  - related
```
protected List<DocumentManifest.DocumentManifestRelatedComponent> related
```
    Related identifiers or resources associated with the DocumentManifest.
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: Unique Identifier for the set of documents
    Type: token
    Path: DocumentManifest.masterIdentifier, DocumentManifest.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: Unique Identifier for the set of documents
    Type: token
    Path: DocumentManifest.masterIdentifier, DocumentManifest.identifier
  - SP_AGENT
```
public static final String SP_AGENT
```
    Search parameter: agent
    Description: Who and/or what had an agent participation
    Type: reference
    Path: DocumentManifest.agent.who
    
    See Also:
    
    Constant Field Values
  - AGENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AGENT
```
    Fluent Client search parameter constant for agent
    Description: Who and/or what had an agent participation
    Type: reference
    Path: DocumentManifest.agent.who
  - INCLUDE_AGENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_AGENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:agent".
  - SP_ITEM
```
public static final String SP_ITEM
```
    Search parameter: item
    Description: Items in manifest
    Type: reference
    Path: DocumentManifest.content
    
    See Also:
    
    Constant Field Values
  - ITEM
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ITEM
```
    Fluent Client search parameter constant for item
    Description: Items in manifest
    Type: reference
    Path: DocumentManifest.content
  - INCLUDE_ITEM
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_ITEM
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:item".
  - SP_RELATED_ID
```
public static final String SP_RELATED_ID
```
    Search parameter: related-id
    Description: Identifiers of things that are related
    Type: token
    Path: DocumentManifest.related.identifier
    
    See Also:
    
    Constant Field Values
  - RELATED_ID
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam RELATED_ID
```
    Fluent Client search parameter constant for related-id
    Description: Identifiers of things that are related
    Type: token
    Path: DocumentManifest.related.identifier
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter: subject
    Description: The subject of the set of documents
    Type: reference
    Path: DocumentManifest.subject
    
    See Also:
    
    Constant Field Values
  - SUBJECT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: The subject of the set of documents
    Type: reference
    Path: DocumentManifest.subject
  - INCLUDE_SUBJECT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:subject".
  - SP_CREATED
```
public static final String SP_CREATED
```
    Search parameter: created
    Description: When this document manifest created
    Type: date
    Path: DocumentManifest.created
    
    See Also:
    
    Constant Field Values
  - CREATED
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam CREATED
```
    Fluent Client search parameter constant for created
    Description: When this document manifest created
    Type: date
    Path: DocumentManifest.created
  - SP_DESCRIPTION
```
public static final String SP_DESCRIPTION
```
    Search parameter: description
    Description: Human-readable description (title)
    Type: string
    Path: DocumentManifest.description
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
```
    Fluent Client search parameter constant for description
    Description: Human-readable description (title)
    Type: string
    Path: DocumentManifest.description
  - SP_SOURCE
```
public static final String SP_SOURCE
```
    Search parameter: source
    Description: The source system/application/software
    Type: uri
    Path: DocumentManifest.source
    
    See Also:
    
    Constant Field Values
  - SOURCE
```
public static final ca.uhn.fhir.rest.gclient.UriClientParam SOURCE
```
    Fluent Client search parameter constant for source
    Description: The source system/application/software
    Type: uri
    Path: DocumentManifest.source
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter: type
    Description: Kind of document set
    Type: token
    Path: DocumentManifest.type
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description: Kind of document set
    Type: token
    Path: DocumentManifest.type
  - SP_RELATED_REF
```
public static final String SP_RELATED_REF
```
    Search parameter: related-ref
    Description: Related Resource
    Type: reference
    Path: DocumentManifest.related.ref
    
    See Also:
    
    Constant Field Values
  - RELATED_REF
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RELATED_REF
```
    Fluent Client search parameter constant for related-ref
    Description: Related Resource
    Type: reference
    Path: DocumentManifest.related.ref
  - INCLUDE_RELATED_REF
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_RELATED_REF
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:related-ref".
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: The subject of the set of documents
    Type: reference
    Path: DocumentManifest.subject
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: The subject of the set of documents
    Type: reference
    Path: DocumentManifest.subject
  - INCLUDE_PATIENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:patient".
  - SP_RECIPIENT
```
public static final String SP_RECIPIENT
```
    Search parameter: recipient
    Description: Intended to get notified about this set of documents
    Type: reference
    Path: DocumentManifest.recipient
    
    See Also:
    
    Constant Field Values
  - RECIPIENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECIPIENT
```
    Fluent Client search parameter constant for recipient
    Description: Intended to get notified about this set of documents
    Type: reference
    Path: DocumentManifest.recipient
  - INCLUDE_RECIPIENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_RECIPIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:recipient".
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter: status
    Description: current | superseded | entered-in-error
    Type: token
    Path: DocumentManifest.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: current | superseded | entered-in-error
    Type: token
    Path: DocumentManifest.status
- Constructor Detail
  - DocumentManifest
```
public DocumentManifest()
```
    Constructor
  - DocumentManifest
```
public DocumentManifest(Enumeration<Enumerations.DocumentReferenceStatus> status)
```
    Constructor
- 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.)
  - setIdentifier
```
public DocumentManifest setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public DocumentManifest addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist
  - 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.
  - getType
```
public CodeableConcept getType()
```
    Returns:
    
    type (The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.)
  - hasType
```
public boolean hasType()
```
  - setType
```
public DocumentManifest setType(CodeableConcept value)
```
    Parameters:
    
    value - type (The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.)
  - 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).)
  - 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.).
  - getAgent
```
public List<DocumentManifest.DocumentManifestAgentComponent> getAgent()
```
    Returns:
    
    agent (An actor taking an active role in the manifest.)
  - setAgent
```
public DocumentManifest setAgent(List<DocumentManifest.DocumentManifestAgentComponent> theAgent)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasAgent
```
public boolean hasAgent()
```
  - addAgent
```
public DocumentManifest.DocumentManifestAgentComponent addAgent()
```
  - addAgent
```
public DocumentManifest addAgent(DocumentManifest.DocumentManifestAgentComponent t)
```
  - getAgentFirstRep
```
public DocumentManifest.DocumentManifestAgentComponent getAgentFirstRep()
```
    Returns:
    
    The first repetition of repeating field agent, creating it if it does not already exist
  - getRecipient
```
public List<Reference> getRecipient()
```
    Returns:
    
    recipient (A patient, practitioner, or organization for which this set of documents is intended.)
  - setRecipient
```
public DocumentManifest setRecipient(List<Reference> theRecipient)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasRecipient
```
public boolean hasRecipient()
```
  - addRecipient
```
public Reference addRecipient()
```
  - addRecipient
```
public DocumentManifest addRecipient(Reference t)
```
  - getRecipientFirstRep
```
public Reference getRecipientFirstRep()
```
    Returns:
    
    The first repetition of repeating field recipient, creating it if it does not already exist
  - getRecipientTarget
```
@Deprecated
public List<Resource> getRecipientTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - 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.
  - 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<Reference> getContent()
```
    Returns:
    
    content (The list of Resources that consist of the parts of this manifest.)
  - setContent
```
public DocumentManifest setContent(List<Reference> theContent)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasContent
```
public boolean hasContent()
```
  - addContent
```
public Reference addContent()
```
  - addContent
```
public DocumentManifest addContent(Reference t)
```
  - getContentFirstRep
```
public Reference getContentFirstRep()
```
    Returns:
    
    The first repetition of repeating field content, creating it if it does not already exist
  - getContentTarget
```
@Deprecated
public List<Resource> getContentTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - getRelated
```
public List<DocumentManifest.DocumentManifestRelatedComponent> getRelated()
```
    Returns:
    
    related (Related identifiers or resources associated with the DocumentManifest.)
  - setRelated
```
public DocumentManifest setRelated(List<DocumentManifest.DocumentManifestRelatedComponent> theRelated)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasRelated
```
public boolean hasRelated()
```
  - addRelated
```
public DocumentManifest.DocumentManifestRelatedComponent addRelated()
```
  - addRelated
```
public DocumentManifest addRelated(DocumentManifest.DocumentManifestRelatedComponent t)
```
  - getRelatedFirstRep
```
public DocumentManifest.DocumentManifestRelatedComponent getRelatedFirstRep()
```
    Returns:
    
    The first repetition of repeating field related, creating it if it does not already exist
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class DomainResource
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty 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()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public DocumentManifest copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected DocumentManifest 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

Class DocumentManifest

Nested Class Summary

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class org.hl7.fhir.r4.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

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

Field Detail

masterIdentifier

identifier

status

type

subject

subjectTarget

created

agent

recipient

recipientTarget

source

description

content

contentTarget

related

SP_IDENTIFIER

IDENTIFIER

SP_AGENT

AGENT

INCLUDE_AGENT

SP_ITEM

ITEM

INCLUDE_ITEM

SP_RELATED_ID

RELATED_ID

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_CREATED

CREATED

SP_DESCRIPTION

DESCRIPTION

SP_SOURCE

SOURCE

SP_TYPE

TYPE

SP_RELATED_REF

RELATED_REF

INCLUDE_RELATED_REF

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_RECIPIENT

RECIPIENT

INCLUDE_RECIPIENT

SP_STATUS

STATUS

Constructor Detail

DocumentManifest

DocumentManifest

Method Detail

getMasterIdentifier

hasMasterIdentifier

setMasterIdentifier

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getStatusElement

hasStatusElement