Class StructureMap.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.StructureMap.Builder
-
- Enclosing class:
- StructureMap
public static class StructureMap.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 StructureMap.Builder
_import(java.util.Collection<Canonical> _import)
Other maps used by this map (canonical URLs).StructureMap.Builder
_import(Canonical... _import)
Other maps used by this map (canonical URLs).StructureMap
build()
Build theStructureMap
StructureMap.Builder
contact(java.util.Collection<ContactDetail> contact)
Contact details to assist a user in finding and communicating with the publisher.StructureMap.Builder
contact(ContactDetail... contact)
Contact details to assist a user in finding and communicating with the publisher.StructureMap.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.StructureMap.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.StructureMap.Builder
copyright(Markdown copyright)
A copyright statement relating to the structure map and/or its contents.StructureMap.Builder
date(DateTime date)
The date (and optionally time) when the structure map was published.StructureMap.Builder
description(Markdown description)
A free text natural language description of the structure map from a consumer's perspective.StructureMap.Builder
experimental(java.lang.Boolean experimental)
Convenience method for settingexperimental
.StructureMap.Builder
experimental(Boolean experimental)
A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.StructureMap.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.StructureMap.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected StructureMap.Builder
from(StructureMap structureMap)
StructureMap.Builder
group(java.util.Collection<StructureMap.Group> group)
Organizes the mapping into manageable chunks for human review/ease of maintenance.StructureMap.Builder
group(StructureMap.Group... group)
Organizes the mapping into manageable chunks for human review/ease of maintenance.StructureMap.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.StructureMap.Builder
identifier(java.util.Collection<Identifier> identifier)
A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.StructureMap.Builder
identifier(Identifier... identifier)
A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.StructureMap.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.StructureMap.Builder
jurisdiction(java.util.Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the structure map is intended to be used.StructureMap.Builder
jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the structure map is intended to be used.StructureMap.Builder
language(Code language)
The base language in which the resource is written.StructureMap.Builder
meta(Meta meta)
The metadata about the resource.StructureMap.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.StructureMap.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.StructureMap.Builder
name(java.lang.String name)
Convenience method for settingname
.StructureMap.Builder
name(String name)
A natural language name identifying the structure map.StructureMap.Builder
publisher(java.lang.String publisher)
Convenience method for settingpublisher
.StructureMap.Builder
publisher(String publisher)
The name of the organization or individual that published the structure map.StructureMap.Builder
purpose(Markdown purpose)
Explanation of why this structure map is needed and why it has been designed as it has.StructureMap.Builder
status(PublicationStatus status)
The status of this structure map.StructureMap.Builder
structure(java.util.Collection<StructureMap.Structure> structure)
A structure definition used by this map.StructureMap.Builder
structure(StructureMap.Structure... structure)
A structure definition used by this map.StructureMap.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.StructureMap.Builder
title(java.lang.String title)
Convenience method for settingtitle
.StructureMap.Builder
title(String title)
A short, descriptive, user-friendly title for the structure map.StructureMap.Builder
url(Uri url)
An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance; also called its canonical identifier.StructureMap.Builder
useContext(java.util.Collection<UsageContext> useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.StructureMap.Builder
useContext(UsageContext... useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.protected void
validate(StructureMap structureMap)
StructureMap.Builder
version(java.lang.String version)
Convenience method for settingversion
.StructureMap.Builder
version(String version)
The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance.-
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 StructureMap.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 StructureMap.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 StructureMap.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 StructureMap.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 StructureMap.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 StructureMap.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 StructureMap.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 StructureMap.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 StructureMap.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 StructureMap.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 StructureMap.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
-
url
public StructureMap.Builder url(Uri url)
An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different servers.This element is required.
- Parameters:
url
- Canonical identifier for this structure map, represented as a URI (globally unique)- Returns:
- A reference to this Builder instance
-
identifier
public StructureMap.Builder identifier(Identifier... identifier)
A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Additional identifier for the structure map- Returns:
- A reference to this Builder instance
-
identifier
public StructureMap.Builder identifier(java.util.Collection<Identifier> identifier)
A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.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
- Additional identifier for the structure map- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
version
public StructureMap.Builder version(java.lang.String version)
Convenience method for settingversion
.- Parameters:
version
- Business version of the structure map- Returns:
- A reference to this Builder instance
- See Also:
version(org.linuxforhealth.fhir.model.type.String)
-
version
public StructureMap.Builder version(String version)
The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.- Parameters:
version
- Business version of the structure map- Returns:
- A reference to this Builder instance
-
name
public StructureMap.Builder name(java.lang.String name)
Convenience method for settingname
.This element is required.
- Parameters:
name
- Name for this structure map (computer friendly)- Returns:
- A reference to this Builder instance
- See Also:
name(org.linuxforhealth.fhir.model.type.String)
-
name
public StructureMap.Builder name(String name)
A natural language name identifying the structure map. 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 structure map (computer friendly)- Returns:
- A reference to this Builder instance
-
title
public StructureMap.Builder title(java.lang.String title)
Convenience method for settingtitle
.- Parameters:
title
- Name for this structure map (human friendly)- Returns:
- A reference to this Builder instance
- See Also:
title(org.linuxforhealth.fhir.model.type.String)
-
title
public StructureMap.Builder title(String title)
A short, descriptive, user-friendly title for the structure map.- Parameters:
title
- Name for this structure map (human friendly)- Returns:
- A reference to this Builder instance
-
status
public StructureMap.Builder status(PublicationStatus status)
The status of this structure map. 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
-
experimental
public StructureMap.Builder experimental(java.lang.Boolean experimental)
Convenience method for settingexperimental
.- Parameters:
experimental
- For testing purposes, not real usage- Returns:
- A reference to this Builder instance
- See Also:
experimental(org.linuxforhealth.fhir.model.type.Boolean)
-
experimental
public StructureMap.Builder experimental(Boolean experimental)
A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.- Parameters:
experimental
- For testing purposes, not real usage- Returns:
- A reference to this Builder instance
-
date
public StructureMap.Builder date(DateTime date)
The date (and optionally time) when the structure map 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 structure map changes.- Parameters:
date
- Date last changed- Returns:
- A reference to this Builder instance
-
publisher
public StructureMap.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 StructureMap.Builder publisher(String publisher)
The name of the organization or individual that published the structure map.- Parameters:
publisher
- Name of the publisher (organization or individual)- Returns:
- A reference to this Builder instance
-
contact
public StructureMap.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 StructureMap.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
-
description
public StructureMap.Builder description(Markdown description)
A free text natural language description of the structure map from a consumer's perspective.- Parameters:
description
- Natural language description of the structure map- Returns:
- A reference to this Builder instance
-
useContext
public StructureMap.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 structure map 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 StructureMap.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 structure map 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 StructureMap.Builder jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the structure map 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 structure map (if applicable)- Returns:
- A reference to this Builder instance
-
jurisdiction
public StructureMap.Builder jurisdiction(java.util.Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the structure map 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 structure map (if applicable)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
purpose
public StructureMap.Builder purpose(Markdown purpose)
Explanation of why this structure map is needed and why it has been designed as it has.- Parameters:
purpose
- Why this structure map is defined- Returns:
- A reference to this Builder instance
-
copyright
public StructureMap.Builder copyright(Markdown copyright)
A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.- Parameters:
copyright
- Use and/or publishing restrictions- Returns:
- A reference to this Builder instance
-
structure
public StructureMap.Builder structure(StructureMap.Structure... structure)
A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
structure
- Structure Definition used by this map- Returns:
- A reference to this Builder instance
-
structure
public StructureMap.Builder structure(java.util.Collection<StructureMap.Structure> structure)
A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.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:
structure
- Structure Definition used by this map- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
_import
public StructureMap.Builder _import(Canonical... _import)
Other maps used by this map (canonical URLs).Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
_import
- Other maps used by this map (canonical URLs)- Returns:
- A reference to this Builder instance
-
_import
public StructureMap.Builder _import(java.util.Collection<Canonical> _import)
Other maps used by this map (canonical URLs).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:
_import
- Other maps used by this map (canonical URLs)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
group
public StructureMap.Builder group(StructureMap.Group... group)
Organizes the mapping into manageable chunks for human review/ease of maintenance.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.This element is required.
- Parameters:
group
- Named sections for reader convenience- Returns:
- A reference to this Builder instance
-
group
public StructureMap.Builder group(java.util.Collection<StructureMap.Group> group)
Organizes the mapping into manageable chunks for human review/ease of maintenance.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:
group
- Named sections for reader convenience- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public StructureMap build()
- Specified by:
build
in interfaceBuilder<Resource>
- Specified by:
build
in classDomainResource.Builder
- Returns:
- An immutable object of type
StructureMap
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid StructureMap per the base specification
-
validate
protected void validate(StructureMap structureMap)
-
from
protected StructureMap.Builder from(StructureMap structureMap)
-
-