Package com.ibm.fhir.model.resource

Class DocumentManifest.Builder

    • Method Detail

      • id

        public DocumentManifest.Builder id​(String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public DocumentManifest.Builder meta​(Meta meta)
        The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public DocumentManifest.Builder implicitRules​(Uri implicitRules)
        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • text

        public DocumentManifest.Builder text​(Narrative text)
        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public DocumentManifest.Builder contained​(Resource... contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Adds new element(s) to the existing list

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public DocumentManifest.Builder contained​(Collection<Resource> contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Replaces the existing list with a new one containing elements from the Collection

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • extension

        public DocumentManifest.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Adds new element(s) to the existing list

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public DocumentManifest.Builder extension​(Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Replaces the existing list with a new one containing elements from the Collection

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public DocumentManifest.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Adds new element(s) to the existing list

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public DocumentManifest.Builder modifierExtension​(Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Replaces the existing list with a new one containing elements from the Collection

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • masterIdentifier

        public DocumentManifest.Builder masterIdentifier​(Identifier masterIdentifier)
        A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
        Parameters:
        masterIdentifier - Unique Identifier for the set of documents
        Returns:
        A reference to this Builder instance

      • identifier

        public DocumentManifest.Builder identifier​(Identifier... identifier)
        Other identifiers associated with the document manifest, including version independent identifiers.

        Adds new element(s) to the existing list

        Parameters:
        identifier - Other identifiers for the manifest
        Returns:
        A reference to this Builder instance

      • identifier

        public DocumentManifest.Builder identifier​(Collection<Identifier> identifier)
        Other identifiers associated with the document manifest, including version independent identifiers.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        identifier - Other identifiers for the manifest
        Returns:
        A reference to this Builder instance

      • status

        public DocumentManifest.Builder status​(DocumentReferenceStatus status)
        The status of this document manifest.

        This element is required.

        Parameters:
        status - current | superseded | entered-in-error
        Returns:
        A reference to this Builder instance

      • type

        public DocumentManifest.Builder type​(CodeableConcept type)
        The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
        Parameters:
        type - Kind of document set
        Returns:
        A reference to this Builder instance

      • subject

        public DocumentManifest.Builder subject​(Reference 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).

        Allowed resource types for this reference:

        Parameters:
        subject - The subject of the set of documents
        Returns:
        A reference to this Builder instance

      • created

        public DocumentManifest.Builder created​(DateTime 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.).
        Parameters:
        created - When this document manifest created
        Returns:
        A reference to this Builder instance

      • author

        public DocumentManifest.Builder author​(Reference... author)
        Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.

        Adds new element(s) to the existing list

        Parameters:
        author - Who and/or what authored the DocumentManifest
        Returns:
        A reference to this Builder instance

      • author

        public DocumentManifest.Builder author​(Collection<Reference> author)
        Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        author - Who and/or what authored the DocumentManifest
        Returns:
        A reference to this Builder instance

      • recipient

        public DocumentManifest.Builder recipient​(Reference... recipient)
        A patient, practitioner, or organization for which this set of documents is intended.

        Adds new element(s) to the existing list

        Parameters:
        recipient - Intended to get notified about this set of documents
        Returns:
        A reference to this Builder instance

      • recipient

        public DocumentManifest.Builder recipient​(Collection<Reference> recipient)
        A patient, practitioner, or organization for which this set of documents is intended.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        recipient - Intended to get notified about this set of documents
        Returns:
        A reference to this Builder instance

      • source

        public DocumentManifest.Builder source​(Uri source)
        Identifies the source system, application, or software that produced the document manifest.
        Parameters:
        source - The source system/application/software
        Returns:
        A reference to this Builder instance

      • description

        public DocumentManifest.Builder description​(String description)
        Human-readable description of the source document. This is sometimes known as the "title".
        Parameters:
        description - Human-readable description (title)
        Returns:
        A reference to this Builder instance

      • content

        public DocumentManifest.Builder content​(Reference... content)
        The list of Resources that consist of the parts of this manifest.

        Adds new element(s) to the existing list

        This element is required.

        Parameters:
        content - Items in manifest
        Returns:
        A reference to this Builder instance

      • content

        public DocumentManifest.Builder content​(Collection<Reference> content)
        The list of Resources that consist of the parts of this manifest.

        Replaces the existing list with a new one containing elements from the Collection

        This element is required.

        Parameters:
        content - Items in manifest
        Returns:
        A reference to this Builder instance

      • related

        public DocumentManifest.Builder related​(DocumentManifest.Related... related)
        Related identifiers or resources associated with the DocumentManifest.

        Adds new element(s) to the existing list

        Parameters:
        related - Related things
        Returns:
        A reference to this Builder instance

      • related

        public DocumentManifest.Builder related​(Collection<DocumentManifest.Related> related)
        Related identifiers or resources associated with the DocumentManifest.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        related - Related things
        Returns:
        A reference to this Builder instance