Package org.linuxforhealth.fhir.model.resource

Class DocumentReference.Builder

    • Method Detail

      • id

        public DocumentReference.Builder id​(java.lang.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 DocumentReference.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 DocumentReference.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 DocumentReference.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 DocumentReference.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. If any of the elements are null, calling build() will fail.

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

      • contained

        public DocumentReference.Builder contained​(java.util.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. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • extension

        public DocumentReference.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. If any of the elements are null, calling build() will fail.

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

      • extension

        public DocumentReference.Builder extension​(java.util.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. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modifierExtension

        public DocumentReference.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. If any of the elements are null, calling build() will fail.

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

      • modifierExtension

        public DocumentReference.Builder modifierExtension​(java.util.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. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • masterIdentifier

        public DocumentReference.Builder masterIdentifier​(Identifier masterIdentifier)
        Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
        Parameters:
        masterIdentifier - Master Version Specific Identifier
        Returns:
        A reference to this Builder instance

      • identifier

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

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

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

      • identifier

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

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        identifier - Other identifiers for the document
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public DocumentReference.Builder status​(DocumentReferenceStatus status)
        The status of this document reference.

        This element is required.

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

      • docStatus

        public DocumentReference.Builder docStatus​(ReferredDocumentStatus docStatus)
        The status of the underlying document.
        Parameters:
        docStatus - preliminary | final | amended | entered-in-error
        Returns:
        A reference to this Builder instance

      • type

        public DocumentReference.Builder type​(CodeableConcept type)
        Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
        Parameters:
        type - Kind of document (LOINC if possible)
        Returns:
        A reference to this Builder instance

      • category

        public DocumentReference.Builder category​(CodeableConcept... category)
        A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        category - Categorization of document
        Returns:
        A reference to this Builder instance

      • category

        public DocumentReference.Builder category​(java.util.Collection<CodeableConcept> category)
        A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        category - Categorization of document
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • subject

        public DocumentReference.Builder subject​(Reference subject)
        Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a 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).

        Allowed resource types for this reference:

        Parameters:
        subject - Who/what is the subject of the document
        Returns:
        A reference to this Builder instance

      • date

        public DocumentReference.Builder date​(Instant date)
        When the document reference was created.
        Parameters:
        date - When this document reference was created
        Returns:
        A reference to this Builder instance

      • author

        public DocumentReference.Builder author​(java.util.Collection<Reference> author)
        Identifies who is responsible for adding the information to the document.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Allowed resource types for the references:

        Parameters:
        author - Who and/or what authored the document
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • custodian

        public DocumentReference.Builder custodian​(Reference custodian)
        Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

        Allowed resource types for this reference:

        Parameters:
        custodian - Organization which maintains the document
        Returns:
        A reference to this Builder instance

      • relatesTo

        public DocumentReference.Builder relatesTo​(DocumentReference.RelatesTo... relatesTo)
        Relationships that this document has with other document references that already exist.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        relatesTo - Relationships to other documents
        Returns:
        A reference to this Builder instance

      • relatesTo

        public DocumentReference.Builder relatesTo​(java.util.Collection<DocumentReference.RelatesTo> relatesTo)
        Relationships that this document has with other document references that already exist.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        relatesTo - Relationships to other documents
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • description

        public DocumentReference.Builder description​(String description)
        Human-readable description of the source document.
        Parameters:
        description - Human-readable description
        Returns:
        A reference to this Builder instance

      • securityLabel

        public DocumentReference.Builder securityLabel​(CodeableConcept... securityLabel)
        A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta. security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        securityLabel - Document security-tags
        Returns:
        A reference to this Builder instance

      • securityLabel

        public DocumentReference.Builder securityLabel​(java.util.Collection<CodeableConcept> securityLabel)
        A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta. security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        securityLabel - Document security-tags
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • content

        public DocumentReference.Builder content​(DocumentReference.Content... content)
        The document and format referenced. There may be multiple content element repetitions, each with a different format.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        This element is required.

        Parameters:
        content - Document referenced
        Returns:
        A reference to this Builder instance

      • content

        public DocumentReference.Builder content​(java.util.Collection<DocumentReference.Content> content)
        The document and format referenced. There may be multiple content element repetitions, each with a different format.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        This element is required.

        Parameters:
        content - Document referenced
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null