Class RegulatedAuthorization.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Resource>
-
- org.linuxforhealth.fhir.model.resource.Resource.Builder
-
- org.linuxforhealth.fhir.model.resource.DomainResource.Builder
-
- org.linuxforhealth.fhir.model.resource.RegulatedAuthorization.Builder
-
- Enclosing class:
- RegulatedAuthorization
public static class RegulatedAuthorization.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RegulatedAuthorization.Builder
_case(RegulatedAuthorization.Case _case)
The case or regulatory procedure for granting or amending a regulated authorization.RegulatedAuthorization.Builder
basis(java.util.Collection<CodeableConcept> basis)
The legal or regulatory framework against which this authorization is granted, or other reasons for it.RegulatedAuthorization.Builder
basis(CodeableConcept... basis)
The legal or regulatory framework against which this authorization is granted, or other reasons for it.RegulatedAuthorization
build()
Build theRegulatedAuthorization
RegulatedAuthorization.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.RegulatedAuthorization.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.RegulatedAuthorization.Builder
description(Markdown description)
General textual supporting information.RegulatedAuthorization.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.RegulatedAuthorization.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected RegulatedAuthorization.Builder
from(RegulatedAuthorization regulatedAuthorization)
RegulatedAuthorization.Builder
holder(Reference holder)
The organization that has been granted this authorization, by some authoritative body (the 'regulator').RegulatedAuthorization.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.RegulatedAuthorization.Builder
identifier(java.util.Collection<Identifier> identifier)
Business identifier for the authorization, typically assigned by the authorizing body.RegulatedAuthorization.Builder
identifier(Identifier... identifier)
Business identifier for the authorization, typically assigned by the authorizing body.RegulatedAuthorization.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.RegulatedAuthorization.Builder
indication(CodeableReference indication)
Condition for which the use of the regulated product applies.RegulatedAuthorization.Builder
intendedUse(CodeableConcept intendedUse)
The intended use of the product, e.g.RegulatedAuthorization.Builder
language(Code language)
The base language in which the resource is written.RegulatedAuthorization.Builder
meta(Meta meta)
The metadata about the resource.RegulatedAuthorization.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.RegulatedAuthorization.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.RegulatedAuthorization.Builder
region(java.util.Collection<CodeableConcept> region)
The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted.RegulatedAuthorization.Builder
region(CodeableConcept... region)
The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted.RegulatedAuthorization.Builder
regulator(Reference regulator)
The regulatory authority or authorizing body granting the authorization.RegulatedAuthorization.Builder
status(CodeableConcept status)
The status that is authorised e.g.RegulatedAuthorization.Builder
statusDate(DateTime statusDate)
The date at which the current status was assigned.RegulatedAuthorization.Builder
subject(java.util.Collection<Reference> subject)
The product type, treatment, facility or activity that is being authorized.RegulatedAuthorization.Builder
subject(Reference... subject)
The product type, treatment, facility or activity that is being authorized.RegulatedAuthorization.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.RegulatedAuthorization.Builder
type(CodeableConcept type)
Overall type of this authorization, for example drug marketing approval, orphan drug designation.protected void
validate(RegulatedAuthorization regulatedAuthorization)
RegulatedAuthorization.Builder
validityPeriod(Period validityPeriod)
The time period in which the regulatory approval, clearance or licencing is in effect.-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public RegulatedAuthorization.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 classDomainResource.Builder
- Parameters:
id
- Logical id of this artifact- Returns:
- A reference to this Builder instance
-
meta
public RegulatedAuthorization.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 classDomainResource.Builder
- Parameters:
meta
- Metadata about the resource- Returns:
- A reference to this Builder instance
-
implicitRules
public RegulatedAuthorization.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 classDomainResource.Builder
- Parameters:
implicitRules
- A set of rules under which this content was created- Returns:
- A reference to this Builder instance
-
language
public RegulatedAuthorization.Builder language(Code language)
The base language in which the resource is written.- Overrides:
language
in classDomainResource.Builder
- Parameters:
language
- Language of the resource content- Returns:
- A reference to this Builder instance
-
text
public RegulatedAuthorization.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 classDomainResource.Builder
- Parameters:
text
- Text summary of the resource, for human interpretation- Returns:
- A reference to this Builder instance
-
contained
public RegulatedAuthorization.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 classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
contained
public RegulatedAuthorization.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 classDomainResource.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 RegulatedAuthorization.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 classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public RegulatedAuthorization.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 classDomainResource.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 RegulatedAuthorization.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 classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
modifierExtension
public RegulatedAuthorization.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 classDomainResource.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
-
identifier
public RegulatedAuthorization.Builder identifier(Identifier... identifier)
Business identifier for the authorization, typically assigned by the authorizing body.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Business identifier for the authorization, typically assigned by the authorizing body- Returns:
- A reference to this Builder instance
-
identifier
public RegulatedAuthorization.Builder identifier(java.util.Collection<Identifier> identifier)
Business identifier for the authorization, typically assigned by the authorizing body.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 the authorization, typically assigned by the authorizing body- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
subject
public RegulatedAuthorization.Builder subject(Reference... subject)
The product type, treatment, facility or activity that is being authorized.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
subject
- The product type, treatment, facility or activity that is being authorized- Returns:
- A reference to this Builder instance
-
subject
public RegulatedAuthorization.Builder subject(java.util.Collection<Reference> subject)
The product type, treatment, facility or activity that is being authorized.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:
subject
- The product type, treatment, facility or activity that is being authorized- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
type
public RegulatedAuthorization.Builder type(CodeableConcept type)
Overall type of this authorization, for example drug marketing approval, orphan drug designation.- Parameters:
type
- Overall type of this authorization, for example drug marketing approval, orphan drug designation- Returns:
- A reference to this Builder instance
-
description
public RegulatedAuthorization.Builder description(Markdown description)
General textual supporting information.- Parameters:
description
- General textual supporting information- Returns:
- A reference to this Builder instance
-
region
public RegulatedAuthorization.Builder region(CodeableConcept... region)
The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
region
- The territory in which the authorization has been granted- Returns:
- A reference to this Builder instance
-
region
public RegulatedAuthorization.Builder region(java.util.Collection<CodeableConcept> region)
The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted.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:
region
- The territory in which the authorization has been granted- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
status
public RegulatedAuthorization.Builder status(CodeableConcept status)
The status that is authorised e.g. approved. Intermediate states and actions can be tracked with cases and applications.- Parameters:
status
- The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications- Returns:
- A reference to this Builder instance
-
statusDate
public RegulatedAuthorization.Builder statusDate(DateTime statusDate)
The date at which the current status was assigned.- Parameters:
statusDate
- The date at which the current status was assigned- Returns:
- A reference to this Builder instance
-
validityPeriod
public RegulatedAuthorization.Builder validityPeriod(Period validityPeriod)
The time period in which the regulatory approval, clearance or licencing is in effect. As an example, a Marketing Authorization includes the date of authorization and/or an expiration date.- Parameters:
validityPeriod
- The time period in which the regulatory approval etc. is in effect, e.g. a Marketing Authorization includes the date of authorization and/or expiration date- Returns:
- A reference to this Builder instance
-
indication
public RegulatedAuthorization.Builder indication(CodeableReference indication)
Condition for which the use of the regulated product applies.- Parameters:
indication
- Condition for which the use of the regulated product applies- Returns:
- A reference to this Builder instance
-
intendedUse
public RegulatedAuthorization.Builder intendedUse(CodeableConcept intendedUse)
The intended use of the product, e.g. prevention, treatment, diagnosis.- Parameters:
intendedUse
- The intended use of the product, e.g. prevention, treatment- Returns:
- A reference to this Builder instance
-
basis
public RegulatedAuthorization.Builder basis(CodeableConcept... basis)
The legal or regulatory framework against which this authorization is granted, or other reasons for it.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
basis
- The legal/regulatory framework or reasons under which this authorization is granted- Returns:
- A reference to this Builder instance
-
basis
public RegulatedAuthorization.Builder basis(java.util.Collection<CodeableConcept> basis)
The legal or regulatory framework against which this authorization is granted, or other reasons for it.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:
basis
- The legal/regulatory framework or reasons under which this authorization is granted- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
holder
public RegulatedAuthorization.Builder holder(Reference holder)
The organization that has been granted this authorization, by some authoritative body (the 'regulator').Allowed resource types for this reference:
- Parameters:
holder
- The organization that has been granted this authorization, by the regulator- Returns:
- A reference to this Builder instance
-
regulator
public RegulatedAuthorization.Builder regulator(Reference regulator)
The regulatory authority or authorizing body granting the authorization. For example, European Medicines Agency (EMA), Food and Drug Administration (FDA), Health Canada (HC), etc.Allowed resource types for this reference:
- Parameters:
regulator
- The regulatory authority or authorizing body granting the authorization- Returns:
- A reference to this Builder instance
-
_case
public RegulatedAuthorization.Builder _case(RegulatedAuthorization.Case _case)
The case or regulatory procedure for granting or amending a regulated authorization. An authorization is granted in response to submissions/applications by those seeking authorization. A case is the administrative process that deals with the application(s) that relate to this and assesses them. Note: This area is subject to ongoing review and the workgroup is seeking implementer feedback on its use (see link at bottom of page).- Parameters:
_case
- The case or regulatory procedure for granting or amending a regulated authorization. Note: This area is subject to ongoing review and the workgroup is seeking implementer feedback on its use (see link at bottom of page)- Returns:
- A reference to this Builder instance
-
build
public RegulatedAuthorization build()
Build theRegulatedAuthorization
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
RegulatedAuthorization
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid RegulatedAuthorization per the base specification
-
validate
protected void validate(RegulatedAuthorization regulatedAuthorization)
-
from
protected RegulatedAuthorization.Builder from(RegulatedAuthorization regulatedAuthorization)
-
-