Package com.ibm.fhir.model.type

Class Signature.Builder

    • Method Detail

      • id

        public Signature.Builder id​(String id)
        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
        Overrides:
        id in class Element.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public Signature.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the element. 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 Element.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public Signature.Builder extension​(Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the element. 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 Element.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • type

        public Signature.Builder type​(Coding... type)
        An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.

        Adds new element(s) to the existing list

        This element is required.

        Parameters:
        type - Indication of the reason the entity signed the object(s)
        Returns:
        A reference to this Builder instance

      • type

        public Signature.Builder type​(Collection<Coding> type)
        An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.

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

        This element is required.

        Parameters:
        type - Indication of the reason the entity signed the object(s)
        Returns:
        A reference to this Builder instance

      • when

        public Signature.Builder when​(Instant when)
        When the digital signature was signed.

        This element is required.

        Parameters:
        when - When the signature was created
        Returns:
        A reference to this Builder instance

      • who

        public Signature.Builder who​(Reference who)
        A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).

        This element is required.

        Allowed resource types for this reference:

        • Practitioner
        • PractitionerRole
        • RelatedPerson
        • Patient
        • Device
        • Organization
        Parameters:
        who - Who signed
        Returns:
        A reference to this Builder instance

      • onBehalfOf

        public Signature.Builder onBehalfOf​(Reference onBehalfOf)
        A reference to an application-usable description of the identity that is represented by the signature.

        Allowed resource types for this reference:

        • Practitioner
        • PractitionerRole
        • RelatedPerson
        • Patient
        • Device
        • Organization
        Parameters:
        onBehalfOf - The party represented
        Returns:
        A reference to this Builder instance

      • targetFormat

        public Signature.Builder targetFormat​(Code targetFormat)
        A mime type that indicates the technical format of the target resources signed by the signature.
        Parameters:
        targetFormat - The technical format of the signed resources
        Returns:
        A reference to this Builder instance

      • sigFormat

        public Signature.Builder sigFormat​(Code sigFormat)
        A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.
        Parameters:
        sigFormat - The technical format of the signature
        Returns:
        A reference to this Builder instance

      • data

        public Signature.Builder data​(Base64Binary data)
        The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
        Parameters:
        data - The actual signature content (XML DigSig. JWS, picture, etc.)
        Returns:
        A reference to this Builder instance