Class 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
-
Field Summary
Modifier and TypeFieldDescriptionIdentifies who is responsible for creating the manifest, and adding documents to it.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for authorThe actual objects that are the target of the reference (Identifies who is responsible for creating the manifest, and adding documents to it.)The list of Documents included in the manifest.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for content-refprotected DateTimeType
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 final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for createdprotected StringType
Human-readable description of the source document.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for descriptionprotected List
<Identifier> Other identifiers associated with the document manifest, including version independent identifiers.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected Identifier
A single identifier that uniquely identifies this manifest.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientA patient, practitioner, or organization for which this set of documents is intended.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for recipientThe actual objects that are the target of the reference (A patient, practitioner, or organization for which this set of documents is intended.)Related identifiers or resources associated with the DocumentManifest.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for related-idstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for related-refprotected UriType
Identifies the source system, application, or software that produced the document manifest.static final ca.uhn.fhir.rest.gclient.UriClientParam
Fluent Client search parameter constant for sourcestatic final String
Search parameter: authorstatic final String
Search parameter: content-refstatic final String
Search parameter: createdstatic final String
Search parameter: descriptionstatic final String
Search parameter: identifierstatic final String
Search parameter: patientstatic final String
Search parameter: recipientstatic final String
Search parameter: related-idstatic final String
Search parameter: related-refstatic final String
Search parameter: sourcestatic final String
Search parameter: statusstatic final String
Search parameter: subjectstatic final String
Search parameter: typeprotected Enumeration
<Enumerations.DocumentReferenceStatus> The status of this document manifest.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected Reference
Who or what the set of documents is about.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected Resource
The actual object that is the target of the reference (Who or what the set of documents is about.protected CodeableConcept
Specifies the kind of this set of documents (e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for typeFields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.dstu3.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
ConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadgetType()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setCreated
(Date value) setCreatedElement
(DateTimeType value) setDescription
(String value) setDescriptionElement
(StringType value) setIdentifier
(List<Identifier> theIdentifier) setMasterIdentifier
(Identifier value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setRecipient
(List<Reference> theRecipient) setSourceElement
(UriType value) setSubject
(Reference value) setSubjectTarget
(Resource value) setType
(CodeableConcept value) protected DocumentManifest
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, 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.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
masterIdentifier
A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts. -
identifier
Other identifiers associated with the document manifest, including version independent identifiers. -
status
The status of this document manifest. -
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. -
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
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
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.). -
author
Identifies who is responsible for creating the manifest, and adding documents to it. -
authorTarget
The actual objects that are the target of the reference (Identifies who is responsible for creating the manifest, and adding documents to it.) -
recipient
A patient, practitioner, or organization for which this set of documents is intended. -
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
Identifies the source system, application, or software that produced the document manifest. -
description
Human-readable description of the source document. This is sometimes known as the "title". -
The list of Documents included in the manifest.
-
SP_IDENTIFIER
Search parameter: identifierDescription: Unique Identifier for the set of documents
Type: token
Path: DocumentManifest.masterIdentifier, DocumentManifest.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Unique Identifier for the set of documents
Type: token
Path: DocumentManifest.masterIdentifier, DocumentManifest.identifier
-
SP_RELATED_ID
Search parameter: related-idDescription: Identifiers of things that are related
Type: token
Path: DocumentManifest.related.identifier
- See Also:
-
RELATED_ID
Fluent Client search parameter constant for related-idDescription: Identifiers of things that are related
Type: token
Path: DocumentManifest.related.identifier
-
SP_CONTENT_REF
Search parameter: content-refDescription: Contents of this set of documents
Type: reference
Path: DocumentManifest.content.pReference
- See Also:
-
CONTENT_REF
Fluent Client search parameter constant for content-refDescription: Contents of this set of documents
Type: reference
Path: DocumentManifest.content.pReference
-
INCLUDE_CONTENT_REF
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:content-ref". -
SP_SUBJECT
Search parameter: subjectDescription: The subject of the set of documents
Type: reference
Path: DocumentManifest.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: The subject of the set of documents
Type: reference
Path: DocumentManifest.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:subject". -
SP_AUTHOR
Search parameter: authorDescription: Who and/or what authored the manifest
Type: reference
Path: DocumentManifest.author
- See Also:
-
AUTHOR
Fluent Client search parameter constant for authorDescription: Who and/or what authored the manifest
Type: reference
Path: DocumentManifest.author
-
INCLUDE_AUTHOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:author". -
SP_CREATED
Search parameter: createdDescription: When this document manifest created
Type: date
Path: DocumentManifest.created
- See Also:
-
CREATED
Fluent Client search parameter constant for createdDescription: When this document manifest created
Type: date
Path: DocumentManifest.created
-
SP_DESCRIPTION
Search parameter: descriptionDescription: Human-readable description (title)
Type: string
Path: DocumentManifest.description
- See Also:
-
DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: Human-readable description (title)
Type: string
Path: DocumentManifest.description
-
SP_SOURCE
Search parameter: sourceDescription: The source system/application/software
Type: uri
Path: DocumentManifest.source
- See Also:
-
SOURCE
Fluent Client search parameter constant for sourceDescription: The source system/application/software
Type: uri
Path: DocumentManifest.source
-
SP_TYPE
Search parameter: typeDescription: Kind of document set
Type: token
Path: DocumentManifest.type
- See Also:
-
TYPE
Fluent Client search parameter constant for typeDescription: Kind of document set
Type: token
Path: DocumentManifest.type
-
SP_RELATED_REF
Search parameter: related-refDescription: Related Resource
Type: reference
Path: DocumentManifest.related.ref
- See Also:
-
RELATED_REF
Fluent Client search parameter constant for related-refDescription: Related Resource
Type: reference
Path: DocumentManifest.related.ref
-
INCLUDE_RELATED_REF
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:related-ref". -
SP_PATIENT
Search parameter: patientDescription: The subject of the set of documents
Type: reference
Path: DocumentManifest.subject
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: The subject of the set of documents
Type: reference
Path: DocumentManifest.subject
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:patient". -
SP_RECIPIENT
Search parameter: recipientDescription: Intended to get notified about this set of documents
Type: reference
Path: DocumentManifest.recipient
- See Also:
-
RECIPIENT
Fluent Client search parameter constant for recipientDescription: Intended to get notified about this set of documents
Type: reference
Path: DocumentManifest.recipient
-
INCLUDE_RECIPIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:recipient". -
SP_STATUS
Search parameter: statusDescription: current | superseded | entered-in-error
Type: token
Path: DocumentManifest.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: current | superseded | entered-in-error
Type: token
Path: DocumentManifest.status
-
-
Constructor Details
-
DocumentManifest
public DocumentManifest()Constructor -
DocumentManifest
Constructor
-
-
Method Details
-
getMasterIdentifier
- Returns:
masterIdentifier
(A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.)
-
hasMasterIdentifier
-
setMasterIdentifier
- Parameters:
value
-masterIdentifier
(A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.)
-
getIdentifier
- Returns:
identifier
(Other identifiers associated with the document manifest, including version independent identifiers.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
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
-
hasStatus
-
setStatusElement
- 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
- Returns:
- The status of this document manifest.
-
setStatus
- Parameters:
value
- The status of this document manifest.
-
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
-
setType
- 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.)
-
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
-
setSubject
- 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
- 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
- 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
- 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
-
hasCreated
-
setCreatedElement
- 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
- 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
- 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.).
-
getAuthor
- Returns:
author
(Identifies who is responsible for creating the manifest, and adding documents to it.)
-
setAuthor
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAuthor
-
addAuthor
-
addAuthor
-
getAuthorFirstRep
- Returns:
- The first repetition of repeating field
author
, creating it if it does not already exist
-
getAuthorTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getRecipient
- Returns:
recipient
(A patient, practitioner, or organization for which this set of documents is intended.)
-
setRecipient
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRecipient
-
addRecipient
-
addRecipient
-
getRecipientFirstRep
- Returns:
- The first repetition of repeating field
recipient
, creating it if it does not already exist
-
getRecipientTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
-
hasSource
-
setSourceElement
- 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
- Returns:
- Identifies the source system, application, or software that produced the document manifest.
-
setSource
- Parameters:
value
- Identifies the source system, application, or software that produced the document manifest.
-
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
-
hasDescription
-
setDescriptionElement
- 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
- Returns:
- Human-readable description of the source document. This is sometimes known as the "title".
-
setDescription
- Parameters:
value
- Human-readable description of the source document. This is sometimes known as the "title".
-
getContent
- Returns:
content
(The list of Documents included in the manifest.)
-
setContent
public DocumentManifest setContent(List<DocumentManifest.DocumentManifestContentComponent> theContent) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasContent
-
addContent
-
addContent
-
getContentFirstRep
- Returns:
- The first repetition of repeating field
content
, creating it if it does not already exist
-
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
-
addRelated
-
addRelated
-
getRelatedFirstRep
- Returns:
- The first repetition of repeating field
related
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-