Package org.linuxforhealth.fhir.model.resource

Class ObservationDefinition.Builder

    • Method Detail

      • id

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

      • category

        public ObservationDefinition.Builder category​(CodeableConcept... category)
        A code that classifies the general type of observation.

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

        Parameters:
        category - Category of observation
        Returns:
        A reference to this Builder instance

      • category

        public ObservationDefinition.Builder category​(java.util.Collection<CodeableConcept> category)
        A code that classifies the general type of observation.

        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 - Category of observation
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • code

        public ObservationDefinition.Builder code​(CodeableConcept code)
        Describes what will be observed. Sometimes this is called the observation "name".

        This element is required.

        Parameters:
        code - Type of observation (code / type)
        Returns:
        A reference to this Builder instance

      • identifier

        public ObservationDefinition.Builder identifier​(Identifier... identifier)
        A unique identifier assigned to this ObservationDefinition artifact.

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

        Parameters:
        identifier - Business identifier for this ObservationDefinition instance
        Returns:
        A reference to this Builder instance

      • identifier

        public ObservationDefinition.Builder identifier​(java.util.Collection<Identifier> identifier)
        A unique identifier assigned to this ObservationDefinition artifact.

        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 - Business identifier for this ObservationDefinition instance
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • permittedDataType

        public ObservationDefinition.Builder permittedDataType​(ObservationDataType... permittedDataType)
        The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.

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

        Parameters:
        permittedDataType - Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
        Returns:
        A reference to this Builder instance

      • permittedDataType

        public ObservationDefinition.Builder permittedDataType​(java.util.Collection<ObservationDataType> permittedDataType)
        The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.

        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:
        permittedDataType - Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • multipleResultsAllowed

        public ObservationDefinition.Builder multipleResultsAllowed​(Boolean multipleResultsAllowed)
        Multiple results allowed for observations conforming to this ObservationDefinition.
        Parameters:
        multipleResultsAllowed - Multiple results allowed
        Returns:
        A reference to this Builder instance

      • method

        public ObservationDefinition.Builder method​(CodeableConcept method)
        The method or technique used to perform the observation.
        Parameters:
        method - Method used to produce the observation
        Returns:
        A reference to this Builder instance

      • preferredReportName

        public ObservationDefinition.Builder preferredReportName​(String preferredReportName)
        The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
        Parameters:
        preferredReportName - Preferred report name
        Returns:
        A reference to this Builder instance

      • qualifiedInterval

        public ObservationDefinition.Builder qualifiedInterval​(ObservationDefinition.QualifiedInterval... qualifiedInterval)
        Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.

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

        Parameters:
        qualifiedInterval - Qualified range for continuous and ordinal observation results
        Returns:
        A reference to this Builder instance

      • qualifiedInterval

        public ObservationDefinition.Builder qualifiedInterval​(java.util.Collection<ObservationDefinition.QualifiedInterval> qualifiedInterval)
        Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.

        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:
        qualifiedInterval - Qualified range for continuous and ordinal observation results
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • validCodedValueSet

        public ObservationDefinition.Builder validCodedValueSet​(Reference validCodedValueSet)
        The set of valid coded results for the observations conforming to this ObservationDefinition.

        Allowed resource types for this reference:

        Parameters:
        validCodedValueSet - Value set of valid coded values for the observations conforming to this ObservationDefinition
        Returns:
        A reference to this Builder instance

      • normalCodedValueSet

        public ObservationDefinition.Builder normalCodedValueSet​(Reference normalCodedValueSet)
        The set of normal coded results for the observations conforming to this ObservationDefinition.

        Allowed resource types for this reference:

        Parameters:
        normalCodedValueSet - Value set of normal coded values for the observations conforming to this ObservationDefinition
        Returns:
        A reference to this Builder instance

      • abnormalCodedValueSet

        public ObservationDefinition.Builder abnormalCodedValueSet​(Reference abnormalCodedValueSet)
        The set of abnormal coded results for the observation conforming to this ObservationDefinition.

        Allowed resource types for this reference:

        Parameters:
        abnormalCodedValueSet - Value set of abnormal coded values for the observations conforming to this ObservationDefinition
        Returns:
        A reference to this Builder instance

      • criticalCodedValueSet

        public ObservationDefinition.Builder criticalCodedValueSet​(Reference criticalCodedValueSet)
        The set of critical coded results for the observation conforming to this ObservationDefinition.

        Allowed resource types for this reference:

        Parameters:
        criticalCodedValueSet - Value set of critical coded values for the observations conforming to this ObservationDefinition
        Returns:
        A reference to this Builder instance