Package com.ibm.fhir.model.resource

Class CatalogEntry.Builder

    • Method Detail

      • id

        public CatalogEntry.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 CatalogEntry.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 CatalogEntry.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

      • language

        public CatalogEntry.Builder language​(Code language)
        The base language in which the resource is written.
        Overrides:
        language in class DomainResource.Builder
        Parameters:
        language - Language of the resource content
        Returns:
        A reference to this Builder instance

      • text

        public CatalogEntry.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 CatalogEntry.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 CatalogEntry.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. 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:
        NullPointerException - If the passed collection is null

      • extension

        public CatalogEntry.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 CatalogEntry.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. 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:
        NullPointerException - If the passed collection is null

      • modifierExtension

        public CatalogEntry.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 CatalogEntry.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. 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:
        NullPointerException - If the passed collection is null

      • identifier

        public CatalogEntry.Builder identifier​(Identifier... identifier)
        Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.

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

        Parameters:
        identifier - Unique identifier of the catalog item
        Returns:
        A reference to this Builder instance

      • identifier

        public CatalogEntry.Builder identifier​(Collection<Identifier> identifier)
        Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.

        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 - Unique identifier of the catalog item
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • type

        public CatalogEntry.Builder type​(CodeableConcept type)
        The type of item - medication, device, service, protocol or other.
        Parameters:
        type - The type of item - medication, device, service, protocol or other
        Returns:
        A reference to this Builder instance

      • orderable

        public CatalogEntry.Builder orderable​(Boolean orderable)
        Whether the entry represents an orderable item.

        This element is required.

        Parameters:
        orderable - Whether the entry represents an orderable item
        Returns:
        A reference to this Builder instance

      • additionalIdentifier

        public CatalogEntry.Builder additionalIdentifier​(Identifier... additionalIdentifier)
        Used in supporting related concepts, e.g. NDC to RxNorm.

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

        Parameters:
        additionalIdentifier - Any additional identifier(s) for the catalog item, in the same granularity or concept
        Returns:
        A reference to this Builder instance

      • additionalIdentifier

        public CatalogEntry.Builder additionalIdentifier​(Collection<Identifier> additionalIdentifier)
        Used in supporting related concepts, e.g. NDC to RxNorm.

        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:
        additionalIdentifier - Any additional identifier(s) for the catalog item, in the same granularity or concept
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • classification

        public CatalogEntry.Builder classification​(CodeableConcept... classification)
        Classes of devices, or ATC for medication.

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

        Parameters:
        classification - Classification (category or class) of the item entry
        Returns:
        A reference to this Builder instance

      • classification

        public CatalogEntry.Builder classification​(Collection<CodeableConcept> classification)
        Classes of devices, or ATC for medication.

        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:
        classification - Classification (category or class) of the item entry
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • status

        public CatalogEntry.Builder status​(PublicationStatus status)
        Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
        Parameters:
        status - draft | active | retired | unknown
        Returns:
        A reference to this Builder instance

      • validityPeriod

        public CatalogEntry.Builder validityPeriod​(Period validityPeriod)
        The time period in which this catalog entry is expected to be active.
        Parameters:
        validityPeriod - The time period in which this catalog entry is expected to be active
        Returns:
        A reference to this Builder instance

      • validTo

        public CatalogEntry.Builder validTo​(DateTime validTo)
        The date until which this catalog entry is expected to be active.
        Parameters:
        validTo - The date until which this catalog entry is expected to be active
        Returns:
        A reference to this Builder instance

      • lastUpdated

        public CatalogEntry.Builder lastUpdated​(DateTime lastUpdated)
        Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
        Parameters:
        lastUpdated - When was this catalog last updated
        Returns:
        A reference to this Builder instance

      • additionalCharacteristic

        public CatalogEntry.Builder additionalCharacteristic​(CodeableConcept... additionalCharacteristic)
        Used for examplefor Out of Formulary, or any specifics.

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

        Parameters:
        additionalCharacteristic - Additional characteristics of the catalog entry
        Returns:
        A reference to this Builder instance

      • additionalCharacteristic

        public CatalogEntry.Builder additionalCharacteristic​(Collection<CodeableConcept> additionalCharacteristic)
        Used for examplefor Out of Formulary, or any specifics.

        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:
        additionalCharacteristic - Additional characteristics of the catalog entry
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • additionalClassification

        public CatalogEntry.Builder additionalClassification​(CodeableConcept... additionalClassification)
        User for example for ATC classification, or.

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

        Parameters:
        additionalClassification - Additional classification of the catalog entry
        Returns:
        A reference to this Builder instance

      • additionalClassification

        public CatalogEntry.Builder additionalClassification​(Collection<CodeableConcept> additionalClassification)
        User for example for ATC classification, or.

        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:
        additionalClassification - Additional classification of the catalog entry
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • relatedEntry

        public CatalogEntry.Builder relatedEntry​(CatalogEntry.RelatedEntry... relatedEntry)
        Used for example, to point to a substance, or to a device used to administer a medication.

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

        Parameters:
        relatedEntry - An item that this catalog entry is related to
        Returns:
        A reference to this Builder instance

      • relatedEntry

        public CatalogEntry.Builder relatedEntry​(Collection<CatalogEntry.RelatedEntry> relatedEntry)
        Used for example, to point to a substance, or to a device used to administer a medication.

        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:
        relatedEntry - An item that this catalog entry is related to
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • validate

        protected void validate​(CatalogEntry catalogEntry)