public class DocumentManifest extends DomainResource
| Modifier and Type | Class and Description |
|---|---|
static class |
DocumentManifest.DocumentManifestContentComponent |
static class |
DocumentManifest.DocumentManifestRelatedComponent |
| Modifier and Type | Field and Description |
|---|---|
protected List<Reference> |
author
Identifies who is responsible for creating the manifest, and adding documents to it.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
AUTHOR
Fluent Client search parameter constant for author
|
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.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
CONTENT_REF
Fluent Client search parameter constant for content-ref
|
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_AUTHOR
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_CONTENT_REF
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.
|
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_AUTHOR
Search parameter: author
|
static String |
SP_CONTENT_REF
Search parameter: content-ref
|
static String |
SP_CREATED
Search parameter: created
|
static String |
SP_DESCRIPTION
Search parameter: description
|
static String |
SP_IDENTIFIER
Search parameter: identifier
|
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
Specifies the kind of this set of documents (e.g.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
TYPE
Fluent Client search parameter constant for type
|
contained, extension, modifierExtension, textid, implicitRules, language, meta| Constructor and Description |
|---|
DocumentManifest()
Constructor
|
DocumentManifest(Enumeration<Enumerations.DocumentReferenceStatus> status)
Constructor
|
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setTextcopyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, setIdcastToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataprotected Identifier masterIdentifier
protected List<Identifier> identifier
protected Reference subject
protected Resource subjectTarget
protected List<Reference> recipient
protected List<Resource> recipientTarget
protected CodeableConcept type
protected List<Reference> author
protected List<Resource> authorTarget
protected DateTimeType created
protected UriType source
protected Enumeration<Enumerations.DocumentReferenceStatus> status
protected StringType description
protected List<DocumentManifest.DocumentManifestContentComponent> content
protected List<DocumentManifest.DocumentManifestRelatedComponent> related
public static final String SP_RELATED_REF
Description: Related Resource
Type: reference
Path: DocumentManifest.related.ref
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RELATED_REF
Description: Related Resource
Type: reference
Path: DocumentManifest.related.ref
public static final ca.uhn.fhir.model.api.Include INCLUDE_RELATED_REF
public static final String SP_RELATED_ID
Description: Identifiers of things that are related
Type: token
Path: DocumentManifest.related.identifier
public static final ca.uhn.fhir.rest.gclient.TokenClientParam RELATED_ID
Description: Identifiers of things that are related
Type: token
Path: DocumentManifest.related.identifier
public static final String SP_CONTENT_REF
Description: Contents of this set of documents
Type: reference
Path: DocumentManifest.content.pReference
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTENT_REF
Description: Contents of this set of documents
Type: reference
Path: DocumentManifest.content.pReference
public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTENT_REF
public static final String SP_STATUS
Description: current | superseded | entered-in-error
Type: token
Path: DocumentManifest.status
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Description: current | superseded | entered-in-error
Type: token
Path: DocumentManifest.status
public static final String SP_SUBJECT
Description: The subject of the set of documents
Type: reference
Path: DocumentManifest.subject
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
Description: The subject of the set of documents
Type: reference
Path: DocumentManifest.subject
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
public static final String SP_TYPE
Description: Kind of document set
Type: token
Path: DocumentManifest.type
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
Description: Kind of document set
Type: token
Path: DocumentManifest.type
public static final String SP_RECIPIENT
Description: Intended to get notified about this set of documents
Type: reference
Path: DocumentManifest.recipient
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECIPIENT
Description: Intended to get notified about this set of documents
Type: reference
Path: DocumentManifest.recipient
public static final ca.uhn.fhir.model.api.Include INCLUDE_RECIPIENT
public static final String SP_AUTHOR
Description: Who and/or what authored the manifest
Type: reference
Path: DocumentManifest.author
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR
Description: Who and/or what authored the manifest
Type: reference
Path: DocumentManifest.author
public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHOR
public static final String SP_PATIENT
Description: The subject of the set of documents
Type: reference
Path: DocumentManifest.subject
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Description: The subject of the set of documents
Type: reference
Path: DocumentManifest.subject
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
public static final String SP_SOURCE
Description: The source system/application/software
Type: uri
Path: DocumentManifest.source
public static final ca.uhn.fhir.rest.gclient.UriClientParam SOURCE
Description: The source system/application/software
Type: uri
Path: DocumentManifest.source
public static final String SP_CREATED
Description: When this document manifest created
Type: date
Path: DocumentManifest.created
public static final ca.uhn.fhir.rest.gclient.DateClientParam CREATED
Description: When this document manifest created
Type: date
Path: DocumentManifest.created
public static final String SP_DESCRIPTION
Description: Human-readable description (title)
Type: string
Path: DocumentManifest.description
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Description: Human-readable description (title)
Type: string
Path: DocumentManifest.description
public static final String SP_IDENTIFIER
Description: Unique Identifier for the set of documents
Type: token
Path: DocumentManifest.masterIdentifier, DocumentManifest.identifier
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Description: Unique Identifier for the set of documents
Type: token
Path: DocumentManifest.masterIdentifier, DocumentManifest.identifier
public DocumentManifest()
public DocumentManifest(Enumeration<Enumerations.DocumentReferenceStatus> status)
public Identifier getMasterIdentifier()
masterIdentifier (A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.)public boolean hasMasterIdentifier()
public DocumentManifest setMasterIdentifier(Identifier value)
value - masterIdentifier (A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.)public List<Identifier> getIdentifier()
identifier (Other identifiers associated with the document manifest, including version independent identifiers.)public boolean hasIdentifier()
public Identifier addIdentifier()
identifier (Other identifiers associated with the document manifest, including version independent identifiers.)public DocumentManifest addIdentifier(Identifier t)
public Reference getSubject()
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).)public boolean hasSubject()
public DocumentManifest setSubject(Reference value)
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).)public Resource getSubjectTarget()
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).)public DocumentManifest setSubjectTarget(Resource value)
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).)public List<Reference> getRecipient()
recipient (A patient, practitioner, or organization for which this set of documents is intended.)public boolean hasRecipient()
public Reference addRecipient()
recipient (A patient, practitioner, or organization for which this set of documents is intended.)public DocumentManifest addRecipient(Reference t)
public List<Resource> getRecipientTarget()
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.)public CodeableConcept getType()
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.)public boolean hasType()
public DocumentManifest setType(CodeableConcept value)
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.)public List<Reference> getAuthor()
author (Identifies who is responsible for creating the manifest, and adding documents to it.)public boolean hasAuthor()
public Reference addAuthor()
author (Identifies who is responsible for creating the manifest, and adding documents to it.)public DocumentManifest addAuthor(Reference t)
public List<Resource> getAuthorTarget()
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.)public DateTimeType getCreatedElement()
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 valuepublic boolean hasCreatedElement()
public boolean hasCreated()
public DocumentManifest setCreatedElement(DateTimeType value)
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 valuepublic Date getCreated()
public DocumentManifest setCreated(Date value)
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.).public UriType getSourceElement()
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 valuepublic boolean hasSourceElement()
public boolean hasSource()
public DocumentManifest setSourceElement(UriType value)
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 valuepublic String getSource()
public DocumentManifest setSource(String value)
value - Identifies the source system, application, or software that produced the document manifest.public Enumeration<Enumerations.DocumentReferenceStatus> getStatusElement()
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 valuepublic boolean hasStatusElement()
public boolean hasStatus()
public DocumentManifest setStatusElement(Enumeration<Enumerations.DocumentReferenceStatus> value)
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 valuepublic Enumerations.DocumentReferenceStatus getStatus()
public DocumentManifest setStatus(Enumerations.DocumentReferenceStatus value)
value - The status of this document manifest.public StringType getDescriptionElement()
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 valuepublic boolean hasDescriptionElement()
public boolean hasDescription()
public DocumentManifest setDescriptionElement(StringType value)
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 valuepublic String getDescription()
public DocumentManifest setDescription(String value)
value - Human-readable description of the source document. This is sometimes known as the "title".public List<DocumentManifest.DocumentManifestContentComponent> getContent()
content (The list of Documents included in the manifest.)public boolean hasContent()
public DocumentManifest.DocumentManifestContentComponent addContent()
content (The list of Documents included in the manifest.)public DocumentManifest addContent(DocumentManifest.DocumentManifestContentComponent t)
public List<DocumentManifest.DocumentManifestRelatedComponent> getRelated()
related (Related identifiers or resources associated with the DocumentManifest.)public boolean hasRelated()
public DocumentManifest.DocumentManifestRelatedComponent addRelated()
related (Related identifiers or resources associated with the DocumentManifest.)public DocumentManifest addRelated(DocumentManifest.DocumentManifestRelatedComponent t)
protected void listChildren(List<Property> childrenList)
listChildren in class DomainResourcepublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in class DomainResourcepublic DocumentManifest copy()
copy in class DomainResourceprotected DocumentManifest typedCopy()
public boolean equalsDeep(Base other)
equalsDeep in class DomainResourcepublic boolean equalsShallow(Base other)
equalsShallow in class DomainResourcepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class DomainResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2018 University Health Network. All rights reserved.