Class NamingSystem.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.NamingSystem.Builder
-
- Enclosing class:
- NamingSystem
public static class NamingSystem.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 NamingSystem
build()
Build theNamingSystem
NamingSystem.Builder
contact(java.util.Collection<ContactDetail> contact)
Contact details to assist a user in finding and communicating with the publisher.NamingSystem.Builder
contact(ContactDetail... contact)
Contact details to assist a user in finding and communicating with the publisher.NamingSystem.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.NamingSystem.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.NamingSystem.Builder
date(DateTime date)
The date (and optionally time) when the naming system was published.NamingSystem.Builder
description(Markdown description)
A free text natural language description of the naming system from a consumer's perspective.NamingSystem.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.NamingSystem.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected NamingSystem.Builder
from(NamingSystem namingSystem)
NamingSystem.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.NamingSystem.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.NamingSystem.Builder
jurisdiction(java.util.Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the naming system is intended to be used.NamingSystem.Builder
jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the naming system is intended to be used.NamingSystem.Builder
kind(NamingSystemType kind)
Indicates the purpose for the naming system - what kinds of things does it make unique?NamingSystem.Builder
language(Code language)
The base language in which the resource is written.NamingSystem.Builder
meta(Meta meta)
The metadata about the resource.NamingSystem.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.NamingSystem.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.NamingSystem.Builder
name(java.lang.String name)
Convenience method for settingname
.NamingSystem.Builder
name(String name)
A natural language name identifying the naming system.NamingSystem.Builder
publisher(java.lang.String publisher)
Convenience method for settingpublisher
.NamingSystem.Builder
publisher(String publisher)
The name of the organization or individual that published the naming system.NamingSystem.Builder
responsible(java.lang.String responsible)
Convenience method for settingresponsible
.NamingSystem.Builder
responsible(String responsible)
The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.NamingSystem.Builder
status(PublicationStatus status)
The status of this naming system.NamingSystem.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.NamingSystem.Builder
type(CodeableConcept type)
Categorizes a naming system for easier search by grouping related naming systems.NamingSystem.Builder
uniqueId(java.util.Collection<NamingSystem.UniqueId> uniqueId)
Indicates how the system may be identified when referenced in electronic exchange.NamingSystem.Builder
uniqueId(NamingSystem.UniqueId... uniqueId)
Indicates how the system may be identified when referenced in electronic exchange.NamingSystem.Builder
usage(java.lang.String usage)
Convenience method for settingusage
.NamingSystem.Builder
usage(String usage)
Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs.NamingSystem.Builder
useContext(java.util.Collection<UsageContext> useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.NamingSystem.Builder
useContext(UsageContext... useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.protected void
validate(NamingSystem namingSystem)
-
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 NamingSystem.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 NamingSystem.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 NamingSystem.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 NamingSystem.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 NamingSystem.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 NamingSystem.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 NamingSystem.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 NamingSystem.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 NamingSystem.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 NamingSystem.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 NamingSystem.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
-
name
public NamingSystem.Builder name(java.lang.String name)
Convenience method for settingname
.This element is required.
- Parameters:
name
- Name for this naming system (computer friendly)- Returns:
- A reference to this Builder instance
- See Also:
name(org.linuxforhealth.fhir.model.type.String)
-
name
public NamingSystem.Builder name(String name)
A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.This element is required.
- Parameters:
name
- Name for this naming system (computer friendly)- Returns:
- A reference to this Builder instance
-
status
public NamingSystem.Builder status(PublicationStatus status)
The status of this naming system. Enables tracking the life-cycle of the content.This element is required.
- Parameters:
status
- draft | active | retired | unknown- Returns:
- A reference to this Builder instance
-
kind
public NamingSystem.Builder kind(NamingSystemType kind)
Indicates the purpose for the naming system - what kinds of things does it make unique?This element is required.
- Parameters:
kind
- codesystem | identifier | root- Returns:
- A reference to this Builder instance
-
date
public NamingSystem.Builder date(DateTime date)
The date (and optionally time) when the naming system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.This element is required.
- Parameters:
date
- Date last changed- Returns:
- A reference to this Builder instance
-
publisher
public NamingSystem.Builder publisher(java.lang.String publisher)
Convenience method for settingpublisher
.- Parameters:
publisher
- Name of the publisher (organization or individual)- Returns:
- A reference to this Builder instance
- See Also:
publisher(org.linuxforhealth.fhir.model.type.String)
-
publisher
public NamingSystem.Builder publisher(String publisher)
The name of the organization or individual that published the naming system.- Parameters:
publisher
- Name of the publisher (organization or individual)- Returns:
- A reference to this Builder instance
-
contact
public NamingSystem.Builder contact(ContactDetail... contact)
Contact details to assist a user in finding and communicating with the publisher.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
contact
- Contact details for the publisher- Returns:
- A reference to this Builder instance
-
contact
public NamingSystem.Builder contact(java.util.Collection<ContactDetail> contact)
Contact details to assist a user in finding and communicating with the publisher.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:
contact
- Contact details for the publisher- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
responsible
public NamingSystem.Builder responsible(java.lang.String responsible)
Convenience method for settingresponsible
.- Parameters:
responsible
- Who maintains system namespace?- Returns:
- A reference to this Builder instance
- See Also:
responsible(org.linuxforhealth.fhir.model.type.String)
-
responsible
public NamingSystem.Builder responsible(String responsible)
The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.- Parameters:
responsible
- Who maintains system namespace?- Returns:
- A reference to this Builder instance
-
type
public NamingSystem.Builder type(CodeableConcept type)
Categorizes a naming system for easier search by grouping related naming systems.- Parameters:
type
- e.g. driver, provider, patient, bank etc.- Returns:
- A reference to this Builder instance
-
description
public NamingSystem.Builder description(Markdown description)
A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.- Parameters:
description
- Natural language description of the naming system- Returns:
- A reference to this Builder instance
-
useContext
public NamingSystem.Builder useContext(UsageContext... useContext)
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
useContext
- The context that the content is intended to support- Returns:
- A reference to this Builder instance
-
useContext
public NamingSystem.Builder useContext(java.util.Collection<UsageContext> useContext)
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.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:
useContext
- The context that the content is intended to support- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
jurisdiction
public NamingSystem.Builder jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the naming system is intended to be used.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
jurisdiction
- Intended jurisdiction for naming system (if applicable)- Returns:
- A reference to this Builder instance
-
jurisdiction
public NamingSystem.Builder jurisdiction(java.util.Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the naming system is intended to be used.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:
jurisdiction
- Intended jurisdiction for naming system (if applicable)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
usage
public NamingSystem.Builder usage(java.lang.String usage)
Convenience method for settingusage
.- Parameters:
usage
- How/where is it used- Returns:
- A reference to this Builder instance
- See Also:
usage(org.linuxforhealth.fhir.model.type.String)
-
usage
public NamingSystem.Builder usage(String usage)
Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.- Parameters:
usage
- How/where is it used- Returns:
- A reference to this Builder instance
-
uniqueId
public NamingSystem.Builder uniqueId(NamingSystem.UniqueId... uniqueId)
Indicates how the system may be identified when referenced in electronic exchange.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.This element is required.
- Parameters:
uniqueId
- Unique identifiers used for system- Returns:
- A reference to this Builder instance
-
uniqueId
public NamingSystem.Builder uniqueId(java.util.Collection<NamingSystem.UniqueId> uniqueId)
Indicates how the system may be identified when referenced in electronic exchange.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.This element is required.
- Parameters:
uniqueId
- Unique identifiers used for system- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public NamingSystem build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
NamingSystem
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid NamingSystem per the base specification
-
validate
protected void validate(NamingSystem namingSystem)
-
from
protected NamingSystem.Builder from(NamingSystem namingSystem)
-
-