public class DocumentManifest extends BaseResource implements IResource
Definition: A manifest that defines a set of documents.
Requirements:
Profile Definition: http://hl7.org/fhir/profiles/DocumentManifest
| Modifier and Type | Class and Description |
|---|---|
static class |
DocumentManifest.Content
Block class for child element: DocumentManifest.content ()
|
static class |
DocumentManifest.Related
Block class for child element: DocumentManifest.related ()
|
| Modifier and Type | Field and Description |
|---|---|
static ReferenceClientParam |
AUTHOR
Fluent Client search parameter constant for author
|
static ReferenceClientParam |
CONTENT_REF
Fluent Client search parameter constant for content-ref
|
static DateClientParam |
CREATED
Fluent Client search parameter constant for created
|
static StringClientParam |
DESCRIPTION
Fluent Client search parameter constant for description
|
static TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static Include |
INCLUDE_AUTHOR
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_CONTENT_REF
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_RECIPIENT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_RELATED_REF
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.
|
static ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
static ReferenceClientParam |
RECIPIENT
Fluent Client search parameter constant for recipient
|
static TokenClientParam |
RELATED_ID
Fluent Client search parameter constant for related-id
|
static ReferenceClientParam |
RELATED_REF
Fluent Client search parameter constant for related-ref
|
static UriClientParam |
SOURCE
Fluent Client search parameter constant for source
|
static String |
SP_AUTHOR
Search parameter constant for author
|
static String |
SP_CONTENT_REF
Search parameter constant for content-ref
|
static String |
SP_CREATED
Search parameter constant for created
|
static String |
SP_DESCRIPTION
Search parameter constant for description
|
static String |
SP_IDENTIFIER
Search parameter constant for identifier
|
static String |
SP_PATIENT
Search parameter constant for patient
|
static String |
SP_RECIPIENT
Search parameter constant for recipient
|
static String |
SP_RELATED_ID
Search parameter constant for related-id
|
static String |
SP_RELATED_REF
Search parameter constant for related-ref
|
static String |
SP_SOURCE
Search parameter constant for source
|
static String |
SP_STATUS
Search parameter constant for status
|
static String |
SP_SUBJECT
Search parameter constant for subject
|
static String |
SP_TYPE
Search parameter constant for type
|
static TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
static ReferenceClientParam |
SUBJECT
Fluent Client search parameter constant for subject
|
static TokenClientParam |
TYPE
Fluent Client search parameter constant for type
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
DocumentManifest() |
| Modifier and Type | Method and Description |
|---|---|
ResourceReferenceDt |
addAuthor()
Adds and returns a new value for author (who.author)
|
DocumentManifest.Content |
addContent()
Adds and returns a new value for content ()
|
DocumentManifest |
addContent(DocumentManifest.Content theValue)
Adds a given new value for content ()
|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier (id)
|
DocumentManifest |
addIdentifier(IdentifierDt theValue)
Adds a given new value for identifier (id)
|
ResourceReferenceDt |
addRecipient()
Adds and returns a new value for recipient (who.cause)
|
DocumentManifest.Related |
addRelated()
Adds and returns a new value for related ()
|
DocumentManifest |
addRelated(DocumentManifest.Related theValue)
Adds a given new value for related ()
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
List<ResourceReferenceDt> |
getAuthor()
Gets the value(s) for author (who.author).
|
List<DocumentManifest.Content> |
getContent()
Gets the value(s) for content ().
|
DocumentManifest.Content |
getContentFirstRep()
Gets the first repetition for content (),
creating it if it does not already exist.
|
Date |
getCreated()
Gets the value(s) for created (when.done).
|
DateTimeDt |
getCreatedElement()
Gets the value(s) for created (when.done).
|
String |
getDescription()
Gets the value(s) for description ().
|
StringDt |
getDescriptionElement()
Gets the value(s) for description ().
|
List<IdentifierDt> |
getIdentifier()
Gets the value(s) for identifier (id).
|
IdentifierDt |
getIdentifierFirstRep()
Gets the first repetition for identifier (id),
creating it if it does not already exist.
|
IdentifierDt |
getMasterIdentifier()
Gets the value(s) for masterIdentifier (id).
|
List<ResourceReferenceDt> |
getRecipient()
Gets the value(s) for recipient (who.cause).
|
List<DocumentManifest.Related> |
getRelated()
Gets the value(s) for related ().
|
DocumentManifest.Related |
getRelatedFirstRep()
Gets the first repetition for related (),
creating it if it does not already exist.
|
String |
getResourceName() |
String |
getSource()
Gets the value(s) for source ().
|
UriDt |
getSourceElement()
Gets the value(s) for source ().
|
String |
getStatus()
Gets the value(s) for status (status).
|
BoundCodeDt<DocumentReferenceStatusEnum> |
getStatusElement()
Gets the value(s) for status (status).
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
ResourceReferenceDt |
getSubject()
Gets the value(s) for subject (who.focus).
|
CodeableConceptDt |
getType()
Gets the value(s) for type (class).
|
boolean |
isEmpty() |
DocumentManifest |
setAuthor(List<ResourceReferenceDt> theValue)
Sets the value(s) for author (who.author)
|
DocumentManifest |
setContent(List<DocumentManifest.Content> theValue)
Sets the value(s) for content ()
|
DocumentManifest |
setCreated(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for created (when.done)
|
DocumentManifest |
setCreated(DateTimeDt theValue)
Sets the value(s) for created (when.done)
|
DocumentManifest |
setCreatedWithSecondsPrecision(Date theDate)
Sets the value for created (when.done)
|
DocumentManifest |
setDescription(String theString)
Sets the value for description ()
|
DocumentManifest |
setDescription(StringDt theValue)
Sets the value(s) for description ()
|
DocumentManifest |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (id)
|
DocumentManifest |
setMasterIdentifier(IdentifierDt theValue)
Sets the value(s) for masterIdentifier (id)
|
DocumentManifest |
setRecipient(List<ResourceReferenceDt> theValue)
Sets the value(s) for recipient (who.cause)
|
DocumentManifest |
setRelated(List<DocumentManifest.Related> theValue)
Sets the value(s) for related ()
|
DocumentManifest |
setSource(String theUri)
Sets the value for source ()
|
DocumentManifest |
setSource(UriDt theValue)
Sets the value(s) for source ()
|
DocumentManifest |
setStatus(BoundCodeDt<DocumentReferenceStatusEnum> theValue)
Sets the value(s) for status (status)
|
DocumentManifest |
setStatus(DocumentReferenceStatusEnum theValue)
Sets the value(s) for status (status)
|
DocumentManifest |
setSubject(ResourceReferenceDt theValue)
Sets the value(s) for subject (who.focus)
|
DocumentManifest |
setType(CodeableConceptDt theValue)
Sets the value(s) for type (class)
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_IDENTIFIER
Description:
Type: token
Path: DocumentManifest.masterIdentifier | DocumentManifest.identifier
public static final TokenClientParam IDENTIFIER
Description:
Type: token
Path: DocumentManifest.masterIdentifier | DocumentManifest.identifier
public static final String SP_SUBJECT
Description:
Type: reference
Path: DocumentManifest.subject
public static final ReferenceClientParam SUBJECT
Description:
Type: reference
Path: DocumentManifest.subject
public static final String SP_TYPE
Description:
Type: token
Path: DocumentManifest.type
public static final TokenClientParam TYPE
Description:
Type: token
Path: DocumentManifest.type
public static final String SP_RECIPIENT
Description:
Type: reference
Path: DocumentManifest.recipient
public static final ReferenceClientParam RECIPIENT
Description:
Type: reference
Path: DocumentManifest.recipient
public static final String SP_AUTHOR
Description:
Type: reference
Path: DocumentManifest.author
public static final ReferenceClientParam AUTHOR
Description:
Type: reference
Path: DocumentManifest.author
public static final String SP_CREATED
Description:
Type: date
Path: DocumentManifest.created
public static final DateClientParam CREATED
Description:
Type: date
Path: DocumentManifest.created
public static final String SP_STATUS
Description:
Type: token
Path: DocumentManifest.status
public static final TokenClientParam STATUS
Description:
Type: token
Path: DocumentManifest.status
public static final String SP_DESCRIPTION
Description:
Type: string
Path: DocumentManifest.description
public static final StringClientParam DESCRIPTION
Description:
Type: string
Path: DocumentManifest.description
public static final String SP_CONTENT_REF
Description:
Type: reference
Path: DocumentManifest.content.pReference
public static final ReferenceClientParam CONTENT_REF
Description:
Type: reference
Path: DocumentManifest.content.pReference
public static final String SP_PATIENT
Description:
Type: reference
Path: DocumentManifest.subject
public static final ReferenceClientParam PATIENT
Description:
Type: reference
Path: DocumentManifest.subject
public static final String SP_SOURCE
Description:
Type: uri
Path: DocumentManifest.source
public static final UriClientParam SOURCE
Description:
Type: uri
Path: DocumentManifest.source
public static final String SP_RELATED_ID
Description:
Type: token
Path: DocumentManifest.related.identifier
public static final TokenClientParam RELATED_ID
Description:
Type: token
Path: DocumentManifest.related.identifier
public static final String SP_RELATED_REF
Description:
Type: reference
Path: DocumentManifest.related.ref
public static final ReferenceClientParam RELATED_REF
Description:
Type: reference
Path: DocumentManifest.related.ref
public static final Include INCLUDE_AUTHOR
public static final Include INCLUDE_CONTENT_REF
public static final Include INCLUDE_PATIENT
public static final Include INCLUDE_RECIPIENT
public static final Include INCLUDE_RELATED_REF
public static final Include INCLUDE_SUBJECT
public DocumentManifest()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic IdentifierDt getMasterIdentifier()
null.
Definition: A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts
public DocumentManifest setMasterIdentifier(IdentifierDt theValue)
Definition: A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts
public List<IdentifierDt> getIdentifier()
null.
Definition: Other identifiers associated with the document manifest, including version independent identifiers
public DocumentManifest setIdentifier(List<IdentifierDt> theValue)
Definition: Other identifiers associated with the document manifest, including version independent identifiers
public IdentifierDt addIdentifier()
Definition: Other identifiers associated with the document manifest, including version independent identifiers
public DocumentManifest addIdentifier(IdentifierDt theValue)
Definition: Other identifiers associated with the document manifest, including version independent identifiers
theValue - The identifier to add (must not be null)public IdentifierDt getIdentifierFirstRep()
Definition: Other identifiers associated with the document manifest, including version independent identifiers
public ResourceReferenceDt getSubject()
null.
Definition: 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)
public DocumentManifest setSubject(ResourceReferenceDt theValue)
Definition: 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)
public List<ResourceReferenceDt> getRecipient()
null.
Definition: A patient, practitioner, or organization for which this set of documents is intended
public DocumentManifest setRecipient(List<ResourceReferenceDt> theValue)
Definition: A patient, practitioner, or organization for which this set of documents is intended
public ResourceReferenceDt addRecipient()
Definition: A patient, practitioner, or organization for which this set of documents is intended
public CodeableConceptDt getType()
null.
Definition: 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
public DocumentManifest setType(CodeableConceptDt theValue)
Definition: 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
public List<ResourceReferenceDt> getAuthor()
null.
Definition: Identifies who is responsible for creating the manifest, and adding documents to it
public DocumentManifest setAuthor(List<ResourceReferenceDt> theValue)
Definition: Identifies who is responsible for creating the manifest, and adding documents to it
public ResourceReferenceDt addAuthor()
Definition: Identifies who is responsible for creating the manifest, and adding documents to it
public DateTimeDt getCreatedElement()
null.
Definition: 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.)
public Date getCreated()
null.
Definition: 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.)
public DocumentManifest setCreated(DateTimeDt theValue)
Definition: 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.)
public DocumentManifest setCreated(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: 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.)
public DocumentManifest setCreatedWithSecondsPrecision(Date theDate)
Definition: 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.)
public UriDt getSourceElement()
null.
Definition: Identifies the source system, application, or software that produced the document manifest
public String getSource()
null.
Definition: Identifies the source system, application, or software that produced the document manifest
public DocumentManifest setSource(UriDt theValue)
Definition: Identifies the source system, application, or software that produced the document manifest
public DocumentManifest setSource(String theUri)
Definition: Identifies the source system, application, or software that produced the document manifest
public BoundCodeDt<DocumentReferenceStatusEnum> getStatusElement()
null.
Definition: The status of this document manifest
public String getStatus()
null.
Definition: The status of this document manifest
public DocumentManifest setStatus(BoundCodeDt<DocumentReferenceStatusEnum> theValue)
Definition: The status of this document manifest
public DocumentManifest setStatus(DocumentReferenceStatusEnum theValue)
Definition: The status of this document manifest
public StringDt getDescriptionElement()
null.
Definition: Human-readable description of the source document. This is sometimes known as the \"title\"
public String getDescription()
null.
Definition: Human-readable description of the source document. This is sometimes known as the \"title\"
public DocumentManifest setDescription(StringDt theValue)
Definition: Human-readable description of the source document. This is sometimes known as the \"title\"
public DocumentManifest setDescription(String theString)
Definition: Human-readable description of the source document. This is sometimes known as the \"title\"
public List<DocumentManifest.Content> getContent()
null.
Definition: The list of Documents included in the manifest.
public DocumentManifest setContent(List<DocumentManifest.Content> theValue)
Definition: The list of Documents included in the manifest.
public DocumentManifest.Content addContent()
Definition: The list of Documents included in the manifest.
public DocumentManifest addContent(DocumentManifest.Content theValue)
Definition: The list of Documents included in the manifest.
theValue - The content to add (must not be null)public DocumentManifest.Content getContentFirstRep()
Definition: The list of Documents included in the manifest.
public List<DocumentManifest.Related> getRelated()
null.
Definition: Related identifiers or resources associated with the DocumentManifest.
public DocumentManifest setRelated(List<DocumentManifest.Related> theValue)
Definition: Related identifiers or resources associated with the DocumentManifest.
public DocumentManifest.Related addRelated()
Definition: Related identifiers or resources associated with the DocumentManifest.
public DocumentManifest addRelated(DocumentManifest.Related theValue)
Definition: Related identifiers or resources associated with the DocumentManifest.
theValue - The related to add (must not be null)public DocumentManifest.Related getRelatedFirstRep()
Definition: Related identifiers or resources associated with the DocumentManifest.
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.