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 | Field and Description |
|---|---|
static ReferenceClientParam |
AUTHOR
Fluent Client search parameter constant for author
|
static TokenClientParam |
CONFIDENTIALITY
Fluent Client search parameter constant for confidentiality
|
static ReferenceClientParam |
CONTENT
Fluent Client search parameter constant for content
|
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
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_SUBJECT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_SUPERCEDES
Constant for fluent queries to be used to add include statements.
|
static ReferenceClientParam |
RECIPIENT
Fluent Client search parameter constant for recipient
|
static String |
SP_AUTHOR
Search parameter constant for author
|
static String |
SP_CONFIDENTIALITY
Search parameter constant for confidentiality
|
static String |
SP_CONTENT
Search parameter constant for content
|
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_RECIPIENT
Search parameter constant for recipient
|
static String |
SP_STATUS
Search parameter constant for status
|
static String |
SP_SUBJECT
Search parameter constant for subject
|
static String |
SP_SUPERSEDES
Search parameter constant for supersedes
|
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 ReferenceClientParam |
SUPERSEDES
Fluent Client search parameter constant for supersedes
|
static TokenClientParam |
TYPE
Fluent Client search parameter constant for type
|
SP_RES_ID, SP_RES_LANGUAGE| Constructor and Description |
|---|
DocumentManifest() |
| Modifier and Type | Method and Description |
|---|---|
ResourceReferenceDt |
addAuthor()
Adds and returns a new value for author (Who and/or what authored the document)
|
ResourceReferenceDt |
addContent()
Adds and returns a new value for content (Contents of this set of documents)
|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier (Other identifiers for the manifest)
|
DocumentManifest |
addIdentifier(IdentifierUseEnum theUse,
String theSystem,
String theValue,
String theLabel)
Adds a new value for identifier (Other identifiers for the manifest)
|
DocumentManifest |
addIdentifier(String theSystem,
String theValue)
Adds a new value for identifier (Other identifiers for the manifest)
|
ResourceReferenceDt |
addRecipient()
Adds and returns a new value for recipient (Intended to get notified about this set of documents)
|
ResourceReferenceDt |
addSubject()
Adds and returns a new value for subject (The subject of the set of documents)
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType)
Returns a list containing all child elements matching a given type
|
List<ResourceReferenceDt> |
getAuthor()
Gets the value(s) for author (Who and/or what authored the document).
|
CodeableConceptDt |
getConfidentiality()
Gets the value(s) for confidentiality (Sensitivity of set of documents).
|
List<ResourceReferenceDt> |
getContent()
Gets the value(s) for content (Contents of this set of documents).
|
DateTimeDt |
getCreated()
Gets the value(s) for created (When this document manifest created).
|
StringDt |
getDescription()
Gets the value(s) for description (Human-readable description (title)).
|
List<IdentifierDt> |
getIdentifier()
Gets the value(s) for identifier (Other identifiers for the manifest).
|
IdentifierDt |
getIdentifierFirstRep()
Gets the first repetition for identifier (Other identifiers for the manifest),
creating it if it does not already exist.
|
IdentifierDt |
getMasterIdentifier()
Gets the value(s) for masterIdentifier (Unique Identifier for the set of documents).
|
List<ResourceReferenceDt> |
getRecipient()
Gets the value(s) for recipient (Intended to get notified about this set of documents).
|
UriDt |
getSource()
Gets the value(s) for source (The source system/application/software).
|
BoundCodeDt<DocumentReferenceStatusEnum> |
getStatus()
Gets the value(s) for status (current | superceded | entered in error).
|
List<ResourceReferenceDt> |
getSubject()
Gets the value(s) for subject (The subject of the set of documents).
|
ResourceReferenceDt |
getSupercedes()
Gets the value(s) for supercedes (If this document manifest replaces another).
|
CodeableConceptDt |
getType()
Gets the value(s) for type (What kind of document set this is).
|
boolean |
isEmpty() |
DocumentManifest |
setAuthor(List<ResourceReferenceDt> theValue)
Sets the value(s) for author (Who and/or what authored the document)
|
DocumentManifest |
setConfidentiality(CodeableConceptDt theValue)
Sets the value(s) for confidentiality (Sensitivity of set of documents)
|
DocumentManifest |
setContent(List<ResourceReferenceDt> theValue)
Sets the value(s) for content (Contents of this set of documents)
|
DocumentManifest |
setCreated(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for created (When this document manifest created)
|
DocumentManifest |
setCreated(DateTimeDt theValue)
Sets the value(s) for created (When this document manifest created)
|
DocumentManifest |
setCreatedWithSecondsPrecision(Date theDate)
Sets the value for created (When this document manifest created)
|
DocumentManifest |
setDescription(String theString)
Sets the value for description (Human-readable description (title))
|
DocumentManifest |
setDescription(StringDt theValue)
Sets the value(s) for description (Human-readable description (title))
|
DocumentManifest |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (Other identifiers for the manifest)
|
DocumentManifest |
setMasterIdentifier(IdentifierDt theValue)
Sets the value(s) for masterIdentifier (Unique Identifier for the set of documents)
|
DocumentManifest |
setMasterIdentifier(IdentifierUseEnum theUse,
String theSystem,
String theValue,
String theLabel)
Sets the value for masterIdentifier (Unique Identifier for the set of documents)
|
DocumentManifest |
setMasterIdentifier(String theSystem,
String theValue)
Sets the value for masterIdentifier (Unique Identifier for the set of documents)
|
DocumentManifest |
setRecipient(List<ResourceReferenceDt> theValue)
Sets the value(s) for recipient (Intended to get notified about this set of documents)
|
DocumentManifest |
setSource(String theUri)
Sets the value for source (The source system/application/software)
|
DocumentManifest |
setSource(UriDt theValue)
Sets the value(s) for source (The source system/application/software)
|
DocumentManifest |
setStatus(BoundCodeDt<DocumentReferenceStatusEnum> theValue)
Sets the value(s) for status (current | superceded | entered in error)
|
DocumentManifest |
setStatus(DocumentReferenceStatusEnum theValue)
Sets the value(s) for status (current | superceded | entered in error)
|
DocumentManifest |
setSubject(List<ResourceReferenceDt> theValue)
Sets the value(s) for subject (The subject of the set of documents)
|
DocumentManifest |
setSupercedes(ResourceReferenceDt theValue)
Sets the value(s) for supercedes (If this document manifest replaces another)
|
DocumentManifest |
setType(CodeableConceptDt theValue)
Sets the value(s) for type (What kind of document set this is)
|
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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, setResourceMetadatapublic 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 Include INCLUDE_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 Include INCLUDE_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 Include INCLUDE_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_SUPERSEDES
Description:
Type: reference
Path: DocumentManifest.supercedes
public static final ReferenceClientParam SUPERSEDES
Description:
Type: reference
Path: DocumentManifest.supercedes
public static final Include INCLUDE_SUPERCEDES
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_CONFIDENTIALITY
Description:
Type: token
Path: DocumentManifest.confidentiality
public static final TokenClientParam CONFIDENTIALITY
Description:
Type: token
Path: DocumentManifest.confidentiality
public static final String SP_CONTENT
Description:
Type: reference
Path: DocumentManifest.content
public static final ReferenceClientParam CONTENT
Description:
Type: reference
Path: DocumentManifest.content
public static final Include INCLUDE_CONTENT
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
ICompositeElementgetAllPopulatedChildElementsOfType in interface ICompositeElementtheType - The type to match. If set to null, all child elements will be returnedpublic 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 DocumentManifest setMasterIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)
Definition: A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts
public DocumentManifest setMasterIdentifier(String theSystem, String 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, including version independent, source record and workflow related identifiers
public DocumentManifest setIdentifier(List<IdentifierDt> theValue)
Definition: Other identifiers associated with the document, including version independent, source record and workflow related identifiers
public IdentifierDt addIdentifier()
Definition: Other identifiers associated with the document, including version independent, source record and workflow related identifiers
public IdentifierDt getIdentifierFirstRep()
Definition: Other identifiers associated with the document, including version independent, source record and workflow related identifiers
public DocumentManifest addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)
Definition: Other identifiers associated with the document, including version independent, source record and workflow related identifiers
public DocumentManifest addIdentifier(String theSystem, String theValue)
Definition: Other identifiers associated with the document, including version independent, source record and workflow related identifiers
public List<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(List<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 ResourceReferenceDt addSubject()
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 adding the information to the document
public DocumentManifest setAuthor(List<ResourceReferenceDt> theValue)
Definition: Identifies who is responsible for adding the information to the document
public ResourceReferenceDt addAuthor()
Definition: Identifies who is responsible for adding the information to the document
public DateTimeDt 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 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 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 UriDt 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> 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 ResourceReferenceDt getSupercedes()
null.
Definition: Whether this document manifest replaces another
public DocumentManifest setSupercedes(ResourceReferenceDt theValue)
Definition: Whether this document manifest replaces another
public StringDt 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 CodeableConceptDt getConfidentiality()
null.
Definition: A code specifying the level of confidentiality of this set of Documents
public DocumentManifest setConfidentiality(CodeableConceptDt theValue)
Definition: A code specifying the level of confidentiality of this set of Documents
public List<ResourceReferenceDt> getContent()
null.
Definition: The list of resources that describe the parts of this document reference. Usually, these would be document references, but direct references to binary attachments and images are also allowed
public DocumentManifest setContent(List<ResourceReferenceDt> theValue)
Definition: The list of resources that describe the parts of this document reference. Usually, these would be document references, but direct references to binary attachments and images are also allowed
public ResourceReferenceDt addContent()
Definition: The list of resources that describe the parts of this document reference. Usually, these would be document references, but direct references to binary attachments and images are also allowed
Copyright © 2014 University Health Network. All rights reserved.