Package org.hl7.fhir.dstu2.model

Class DocumentManifest

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.BaseResource

org.hl7.fhir.dstu2.model.Resource

org.hl7.fhir.dstu2.model.DomainResource

org.hl7.fhir.dstu2.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 manifest that defines a set of documents.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentManifest.DocumentManifestContentComponent
static class	DocumentManifest.DocumentManifestRelatedComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Reference>	author	Identifies who is responsible for creating the manifest, and adding documents to it.
protected List<Resource>	authorTarget	The actual objects that are the target of the reference (Identifies who is responsible for creating the manifest, and adding documents to it.)
protected List<DocumentManifest.DocumentManifestContentComponent>	content	The list of Documents included in the 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.).
protected StringType	description	Human-readable description of the source document.
protected List<Identifier>	identifier	Other identifiers associated with the document manifest, including version independent identifiers.
protected Identifier	masterIdentifier	A single identifier that uniquely identifies this manifest.
protected List<Reference>	recipient	A patient, practitioner, or organization for which this set of documents is intended.
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.
protected UriType	source	Identifies the source system, application, or software that produced the document manifest.
static final String	SP_AUTHOR
static final String	SP_CONTENTREF
static final String	SP_CREATED
static final String	SP_DESCRIPTION
static final String	SP_IDENTIFIER
static final String	SP_PATIENT
static final String	SP_RECIPIENT
static final String	SP_RELATEDID
static final String	SP_RELATEDREF
static final String	SP_SOURCE
static final String	SP_STATUS
static final String	SP_SUBJECT
static final String	SP_TYPE
protected Enumeration<Enumerations.DocumentReferenceStatus>	status	The status of this document manifest.
protected Reference	subject	Who or what the set of documents is about.
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	Specifies the kind of this set of documents (e.g.

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Reference	addAuthor()
DocumentManifest	addAuthor(Reference t)
Base	addChild(String name)
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)
String	fhirType()
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()
protected void	listChildren(List<Property> childrenList)
DocumentManifest	setCreated(Date value)
DocumentManifest	setCreatedElement(DateTimeType value)
DocumentManifest	setDescription(String value)
DocumentManifest	setDescriptionElement(StringType value)
DocumentManifest	setMasterIdentifier(Identifier value)
void	setProperty(String name, Base 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)
protected DocumentManifest	typedCopy()

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

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText

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

getStructureFhirVersionEnum, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

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.

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

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

type

protected CodeableConcept 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.

author

protected List<Reference> author

Identifies who is responsible for creating the manifest, and adding documents to it.

authorTarget

protected List<Resource> authorTarget

The actual objects that are the target of the reference (Identifies who is responsible for creating the manifest, and adding documents to it.)

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

source

protected UriType source

Identifies the source system, application, or software that produced the document manifest.

status

protected Enumeration<Enumerations.DocumentReferenceStatus> status

The status of this document manifest.

description

protected StringType description

Human-readable description of the source document. This is sometimes known as the "title".

content

protected List<DocumentManifest.DocumentManifestContentComponent> content

The list of Documents included in the manifest.

related

protected List<DocumentManifest.DocumentManifestRelatedComponent> related

Related identifiers or resources associated with the DocumentManifest.

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 Details

DocumentManifest

public DocumentManifest()

DocumentManifest

public DocumentManifest(Enumeration<Enumerations.DocumentReferenceStatus> status)

Method Details

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)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

setProperty

public void setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty 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()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

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