Package com.babylonhealth.lit.hl7_java.builders

Class DocumentReferenceBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(com.babylonhealth.lit.hl7.DOCUMENT_REFERENCE_STATUS status,
            java.util.Collection<com.babylonhealth.lit.hl7.model.DocumentReference.Content> content)
        Required fields for DocumentReference
        Parameters:
        status - - The status of this document reference.
        content - - The document and format referenced. There may be multiple content element repetitions, each with a different format.

    • Method Detail

      • withId

        public DocumentReferenceBuilder.Impl withId​(@NonNull
                                            @NonNull java.lang.String id)
        Parameters:
        id - - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      • withMeta

        public DocumentReferenceBuilder.Impl withMeta​(@NonNull
                                              @NonNull com.babylonhealth.lit.core.model.Meta meta)
        Parameters:
        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.

      • withText

        public DocumentReferenceBuilder.Impl withText​(@NonNull
                                              @NonNull com.babylonhealth.lit.hl7.model.Narrative text)
        Parameters:
        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.

      • withType

        public DocumentReferenceBuilder.Impl withType​(@NonNull
                                              @NonNull com.babylonhealth.lit.core.model.CodeableConcept _type)
        Parameters:
        _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.

      • withType

        public DocumentReferenceBuilder.Impl withType​(@NonNull
                                              @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder _type)

      • withDate

        public DocumentReferenceBuilder.Impl withDate​(@NonNull
                                              @NonNull java.time.ZonedDateTime date)
        Parameters:
        date - - When the document reference was created.

      • withAuthor

        public DocumentReferenceBuilder.Impl withAuthor​(@NonNull
                                                @NonNull com.babylonhealth.lit.core.model.Reference... author)
        Parameters:
        author - - Identifies who is responsible for adding the information to the document.

      • withAuthor

        public DocumentReferenceBuilder.Impl withAuthor​(@NonNull
                                                @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Reference> author)
        Parameters:
        author - - Identifies who is responsible for adding the information to the document.

      • withAuthor

        public DocumentReferenceBuilder.Impl withAuthor​(@NonNull
                                                @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder... author)

      • withSubject

        public DocumentReferenceBuilder.Impl withSubject​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core.model.Reference subject)
        Parameters:
        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).

      • withSubject

        public DocumentReferenceBuilder.Impl withSubject​(@NonNull
                                                 @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder subject)

      • withLanguage

        public DocumentReferenceBuilder.Impl withLanguage​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core.LANGUAGES language)
        Parameters:
        language - - The base language in which the resource is written.

      • withCategory

        public DocumentReferenceBuilder.Impl withCategory​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core.model.CodeableConcept... category)
        Parameters:
        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.

      • withCategory

        public DocumentReferenceBuilder.Impl withCategory​(@NonNull
                                                  @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> category)
        Parameters:
        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.

      • withCategory

        public DocumentReferenceBuilder.Impl withCategory​(@NonNull
                                                  @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... category)

      • withContained

        public DocumentReferenceBuilder.Impl withContained​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.Resource... contained)
        Parameters:
        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.

      • withContained

        public DocumentReferenceBuilder.Impl withContained​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Resource> contained)
        Parameters:
        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.

      • withContained

        public DocumentReferenceBuilder.Impl withContained​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.ResourceBuilder... contained)

      • withExtension

        public DocumentReferenceBuilder.Impl withExtension​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.Extension... extension)
        Parameters:
        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.

      • withExtension

        public DocumentReferenceBuilder.Impl withExtension​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Extension> extension)
        Parameters:
        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.

      • withExtension

        public DocumentReferenceBuilder.Impl withExtension​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... extension)

      • withDocStatus

        public DocumentReferenceBuilder.Impl withDocStatus​(@NonNull
                                                   @NonNull com.babylonhealth.lit.hl7.COMPOSITION_STATUS docStatus)
        Parameters:
        docStatus - - The status of the underlying document.

      • withCustodian

        public DocumentReferenceBuilder.Impl withCustodian​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.Reference custodian)
        Parameters:
        custodian - - Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

      • withCustodian

        public DocumentReferenceBuilder.Impl withCustodian​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder custodian)

      • withIdentifier

        public DocumentReferenceBuilder.Impl withIdentifier​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core.model.Identifier... identifier)
        Parameters:
        identifier - - Other identifiers associated with the document, including version independent identifiers.

      • withIdentifier

        public DocumentReferenceBuilder.Impl withIdentifier​(@NonNull
                                                    @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Identifier> identifier)
        Parameters:
        identifier - - Other identifiers associated with the document, including version independent identifiers.

      • withIdentifier

        public DocumentReferenceBuilder.Impl withIdentifier​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core_java.builders.IdentifierBuilder... identifier)

      • withDescription

        public DocumentReferenceBuilder.Impl withDescription​(@NonNull
                                                     @NonNull java.lang.String description)
        Parameters:
        description - - Human-readable description of the source document.

      • withImplicitRules

        public DocumentReferenceBuilder.Impl withImplicitRules​(@NonNull
                                                       @NonNull java.lang.String implicitRules)
        Parameters:
        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.

      • withAuthenticator

        public DocumentReferenceBuilder.Impl withAuthenticator​(@NonNull
                                                       @NonNull com.babylonhealth.lit.core.model.Reference authenticator)
        Parameters:
        authenticator - - Which person or organization authenticates that this document is valid.

      • withAuthenticator

        public DocumentReferenceBuilder.Impl withAuthenticator​(@NonNull
                                                       @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder authenticator)

      • withSecurityLabel

        public DocumentReferenceBuilder.Impl withSecurityLabel​(@NonNull
                                                       @NonNull com.babylonhealth.lit.core.model.CodeableConcept... securityLabel)
        Parameters:
        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.

      • withSecurityLabel

        public DocumentReferenceBuilder.Impl withSecurityLabel​(@NonNull
                                                       @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> securityLabel)
        Parameters:
        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.

      • withSecurityLabel

        public DocumentReferenceBuilder.Impl withSecurityLabel​(@NonNull
                                                       @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... securityLabel)

      • withMasterIdentifier

        public DocumentReferenceBuilder.Impl withMasterIdentifier​(@NonNull
                                                          @NonNull com.babylonhealth.lit.core.model.Identifier masterIdentifier)
        Parameters:
        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.

      • withMasterIdentifier

        public DocumentReferenceBuilder.Impl withMasterIdentifier​(@NonNull
                                                          @NonNull com.babylonhealth.lit.core_java.builders.IdentifierBuilder masterIdentifier)

      • withModifierExtension

        public DocumentReferenceBuilder.Impl withModifierExtension​(@NonNull
                                                           @NonNull com.babylonhealth.lit.core.model.Extension... modifierExtension)
        Parameters:
        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).

      • withModifierExtension

        public DocumentReferenceBuilder.Impl withModifierExtension​(@NonNull
                                                           @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Extension> modifierExtension)
        Parameters:
        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).

      • withModifierExtension

        public DocumentReferenceBuilder.Impl withModifierExtension​(@NonNull
                                                           @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... modifierExtension)

      • withContext

        public DocumentReferenceBuilder.Impl withContext​(@NonNull
                                                 com.babylonhealth.lit.hl7.model.DocumentReference.Context context)
        Parameters:
        context - - The clinical context in which the document was prepared.

      • withRelatesTo

        public DocumentReferenceBuilder.Impl withRelatesTo​(@NonNull
                                                   @NonNull com.babylonhealth.lit.hl7.model.DocumentReference.RelatesTo... relatesTo)
        Parameters:
        relatesTo - - Relationships that this document has with other document references that already exist.

      • withRelatesTo

        public DocumentReferenceBuilder.Impl withRelatesTo​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.DocumentReference.RelatesTo> relatesTo)
        Parameters:
        relatesTo - - Relationships that this document has with other document references that already exist.

      • build

        public com.babylonhealth.lit.hl7.model.DocumentReference build()
        Specified by:
        build in interface DocumentReferenceBuilder
        Specified by:
        build in interface DomainResourceBuilder
        Specified by:
        build in interface com.babylonhealth.lit.core_java.builders.ResourceBuilder