Package ca.uhn.fhir.model.dstu2.resource

Class DocumentManifest

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource
    public class DocumentManifest
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR DocumentManifest Resource (infrastructure.documents)

    Definition: A manifest that defines a set of documents.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/DocumentManifest

    See Also:
    Serialized Form

    • Field Detail

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter constant for identifier

        Description:
        Type: token
        Path: DocumentManifest.masterIdentifier | DocumentManifest.identifier

        See Also:
        Constant Field Values

      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description:
        Type: token
        Path: DocumentManifest.masterIdentifier | DocumentManifest.identifier

      • SUBJECT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
        Fluent Client search parameter constant for subject

        Description:
        Type: reference
        Path: DocumentManifest.subject

      • TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
        Fluent Client search parameter constant for type

        Description:
        Type: token
        Path: DocumentManifest.type

      • RECIPIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECIPIENT
        Fluent Client search parameter constant for recipient

        Description:
        Type: reference
        Path: DocumentManifest.recipient

      • AUTHOR

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR
        Fluent Client search parameter constant for author

        Description:
        Type: reference
        Path: DocumentManifest.author

      • CREATED

        public static final ca.uhn.fhir.rest.gclient.DateClientParam CREATED
        Fluent Client search parameter constant for created

        Description:
        Type: date
        Path: DocumentManifest.created

      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description:
        Type: token
        Path: DocumentManifest.status

      • DESCRIPTION

        public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
        Fluent Client search parameter constant for description

        Description:
        Type: string
        Path: DocumentManifest.description

      • CONTENT_REF

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTENT_REF
        Fluent Client search parameter constant for content-ref

        Description:
        Type: reference
        Path: DocumentManifest.content.pReference

      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description:
        Type: reference
        Path: DocumentManifest.subject

      • SOURCE

        public static final ca.uhn.fhir.rest.gclient.UriClientParam SOURCE
        Fluent Client search parameter constant for source

        Description:
        Type: uri
        Path: DocumentManifest.source

      • RELATED_ID

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam RELATED_ID
        Fluent Client search parameter constant for related-id

        Description:
        Type: token
        Path: DocumentManifest.related.identifier

      • RELATED_REF

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RELATED_REF
        Fluent Client search parameter constant for related-ref

        Description:
        Type: reference
        Path: DocumentManifest.related.ref

      • INCLUDE_AUTHOR

        public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHOR
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:author".

      • INCLUDE_CONTENT_REF

        public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTENT_REF
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:content-ref".

      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:patient".

      • INCLUDE_RECIPIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_RECIPIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:recipient".

      • INCLUDE_RELATED_REF

        public static final ca.uhn.fhir.model.api.Include INCLUDE_RELATED_REF
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:related-ref".

      • INCLUDE_SUBJECT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "DocumentManifest:subject".

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase

      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

      • getMasterIdentifier

        public IdentifierDt getMasterIdentifier()
        Gets the value(s) for masterIdentifier (id). creating it if it does not exist. Will not return null.

        Definition: A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts

      • setMasterIdentifier

        public DocumentManifest setMasterIdentifier​(IdentifierDt theValue)
        Sets the value(s) for masterIdentifier (id)

        Definition: A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts

      • getIdentifier

        public List<IdentifierDt> getIdentifier()
        Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

        Definition: Other identifiers associated with the document manifest, including version independent identifiers

      • setIdentifier

        public DocumentManifest setIdentifier​(List<IdentifierDt> theValue)
        Sets the value(s) for identifier (id)

        Definition: Other identifiers associated with the document manifest, including version independent identifiers

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier (id)

        Definition: Other identifiers associated with the document manifest, including version independent identifiers

      • addIdentifier

        public DocumentManifest addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition: Other identifiers associated with the document manifest, including version independent identifiers

        Parameters:
        theValue - The identifier to add (must not be null)

      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (id), creating it if it does not already exist.

        Definition: Other identifiers associated with the document manifest, including version independent identifiers

      • getSubject

        public ResourceReferenceDt getSubject()
        Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not return 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)

      • setSubject

        public DocumentManifest setSubject​(ResourceReferenceDt theValue)
        Sets the value(s) for subject (who.focus)

        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)

      • getRecipient

        public List<ResourceReferenceDt> getRecipient()
        Gets the value(s) for recipient (who.cause). creating it if it does not exist. Will not return null.

        Definition: A patient, practitioner, or organization for which this set of documents is intended

      • addRecipient

        public ResourceReferenceDt addRecipient()
        Adds and returns a new value for recipient (who.cause)

        Definition: A patient, practitioner, or organization for which this set of documents is intended

      • getType

        public CodeableConceptDt getType()
        Gets the value(s) for type (class). creating it if it does not exist. Will not return 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

      • setType

        public DocumentManifest setType​(CodeableConceptDt theValue)
        Sets the value(s) for type (class)

        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

      • getAuthor

        public List<ResourceReferenceDt> getAuthor()
        Gets the value(s) for author (who.author). creating it if it does not exist. Will not return null.

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

      • addAuthor

        public ResourceReferenceDt addAuthor()
        Adds and returns a new value for author (who.author)

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

      • getCreatedElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getCreatedElement()
        Gets the value(s) for created (when.done). creating it if it does not exist. Will not return 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.)

      • getCreated

        public Date getCreated()
        Gets the value(s) for created (when.done). creating it if it does not exist. This method may return 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.)

      • setCreated

        public DocumentManifest setCreated​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for created (when.done)

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

      • setCreated

        public DocumentManifest setCreated​(Date theDate,
                                   ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for created (when.done)

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

      • setCreatedWithSecondsPrecision

        public DocumentManifest setCreatedWithSecondsPrecision​(Date theDate)
        Sets the value for created (when.done)

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

      • getSourceElement

        public ca.uhn.fhir.model.primitive.UriDt getSourceElement()
        Gets the value(s) for source (). creating it if it does not exist. Will not return null.

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

      • getSource

        public String getSource()
        Gets the value(s) for source (). creating it if it does not exist. This method may return null.

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

      • setSource

        public DocumentManifest setSource​(ca.uhn.fhir.model.primitive.UriDt theValue)
        Sets the value(s) for source ()

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

      • setSource

        public DocumentManifest setSource​(String theUri)
        Sets the value for source ()

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

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<DocumentReferenceStatusEnum> getStatusElement()
        Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

        Definition: The status of this document manifest

      • getStatus

        public String getStatus()
        Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

        Definition: The status of this document manifest

      • getDescriptionElement

        public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
        Gets the value(s) for description (). creating it if it does not exist. Will not return null.

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

      • getDescription

        public String getDescription()
        Gets the value(s) for description (). creating it if it does not exist. This method may return null.

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

      • setDescription

        public DocumentManifest setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for description ()

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

      • setDescription

        public DocumentManifest setDescription​(String theString)
        Sets the value for description ()

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

      • getContent

        public List<DocumentManifest.Content> getContent()
        Gets the value(s) for content (). creating it if it does not exist. Will not return null.

        Definition: The list of Documents included in the manifest.

      • getContentFirstRep

        public DocumentManifest.Content getContentFirstRep()
        Gets the first repetition for content (), creating it if it does not already exist.

        Definition: The list of Documents included in the manifest.

      • getRelated

        public List<DocumentManifest.Related> getRelated()
        Gets the value(s) for related (). creating it if it does not exist. Will not return null.

        Definition: Related identifiers or resources associated with the DocumentManifest.

      • addRelated

        public DocumentManifest.Related addRelated()
        Adds and returns a new value for related ()

        Definition: Related identifiers or resources associated with the DocumentManifest.

      • addRelated

        public DocumentManifest addRelated​(DocumentManifest.Related theValue)
        Adds a given new value for related ()

        Definition: Related identifiers or resources associated with the DocumentManifest.

        Parameters:
        theValue - The related to add (must not be null)

      • getRelatedFirstRep

        public DocumentManifest.Related getRelatedFirstRep()
        Gets the first repetition for related (), creating it if it does not already exist.

        Definition: Related identifiers or resources associated with the DocumentManifest.

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource

      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource