Class ImplementationGuide
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.ImplementationGuide
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class ImplementationGuide extends DomainResource
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.Maturity level: FMM1 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImplementationGuide.Builder
static class
ImplementationGuide.Definition
The information needed by an IG publisher tool to publish the whole implementation guide.static class
ImplementationGuide.DependsOn
Another implementation guide that this implementation depends on.static class
ImplementationGuide.Global
A set of profiles that all resources covered by this implementation guide must conform to.static class
ImplementationGuide.Manifest
Information about an assembled implementation guide, created by the publication tooling.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static ImplementationGuide.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<ContactDetail>
getContact()
Contact details to assist a user in finding and communicating with the publisher.Markdown
getCopyright()
A copyright statement relating to the implementation guide and/or its contents.DateTime
getDate()
The date (and optionally time) when the implementation guide was published.ImplementationGuide.Definition
getDefinition()
The information needed by an IG publisher tool to publish the whole implementation guide.java.util.List<ImplementationGuide.DependsOn>
getDependsOn()
Another implementation guide that this implementation depends on.Markdown
getDescription()
A free text natural language description of the implementation guide from a consumer's perspective.Boolean
getExperimental()
A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.java.util.List<FHIRVersion>
getFhirVersion()
The version(s) of the FHIR specification that this ImplementationGuide targets - e.g.java.util.List<ImplementationGuide.Global>
getGlobal()
A set of profiles that all resources covered by this implementation guide must conform to.java.util.List<CodeableConcept>
getJurisdiction()
A legal or geographic region in which the implementation guide is intended to be used.SPDXLicense
getLicense()
The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.ImplementationGuide.Manifest
getManifest()
Information about an assembled implementation guide, created by the publication tooling.String
getName()
A natural language name identifying the implementation guide.Id
getPackageId()
The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies.String
getPublisher()
The name of the organization or individual that published the implementation guide.PublicationStatus
getStatus()
The status of this implementation guide.String
getTitle()
A short, descriptive, user-friendly title for the implementation guide.Uri
getUrl()
An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance; also called its canonical identifier.java.util.List<UsageContext>
getUseContext()
The content was developed with a focus and intent of supporting the contexts that are listed.String
getVersion()
The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance.boolean
hasChildren()
int
hashCode()
ImplementationGuide.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getUrl
public Uri getUrl()
An absolute URI that is used to identify this implementation guide 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 implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.- Returns:
- An immutable object of type
Uri
that is non-null.
-
getVersion
public String getVersion()
The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide 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.- Returns:
- An immutable object of type
String
that may be null.
-
getName
public String getName()
A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.- Returns:
- An immutable object of type
String
that is non-null.
-
getTitle
public String getTitle()
A short, descriptive, user-friendly title for the implementation guide.- Returns:
- An immutable object of type
String
that may be null.
-
getStatus
public PublicationStatus getStatus()
The status of this implementation guide. Enables tracking the life-cycle of the content.- Returns:
- An immutable object of type
PublicationStatus
that is non-null.
-
getExperimental
public Boolean getExperimental()
A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getDate
public DateTime getDate()
The date (and optionally time) when the implementation guide 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 implementation guide changes.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getPublisher
public String getPublisher()
The name of the organization or individual that published the implementation guide.- Returns:
- An immutable object of type
String
that may be null.
-
getContact
public java.util.List<ContactDetail> getContact()
Contact details to assist a user in finding and communicating with the publisher.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getDescription
public Markdown getDescription()
A free text natural language description of the implementation guide from a consumer's perspective.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getUseContext
public java.util.List<UsageContext> getUseContext()
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 implementation guide instances.- Returns:
- An unmodifiable list containing immutable objects of type
UsageContext
that may be empty.
-
getJurisdiction
public java.util.List<CodeableConcept> getJurisdiction()
A legal or geographic region in which the implementation guide is intended to be used.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getCopyright
public Markdown getCopyright()
A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getPackageId
public Id getPackageId()
The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.- Returns:
- An immutable object of type
Id
that is non-null.
-
getLicense
public SPDXLicense getLicense()
The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.- Returns:
- An immutable object of type
SPDXLicense
that may be null.
-
getFhirVersion
public java.util.List<FHIRVersion> getFhirVersion()
The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major]. [minor], which is 4.3.0-cibuild. for this version.- Returns:
- An unmodifiable list containing immutable objects of type
FHIRVersion
that is non-empty.
-
getDependsOn
public java.util.List<ImplementationGuide.DependsOn> getDependsOn()
Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.- Returns:
- An unmodifiable list containing immutable objects of type
ImplementationGuide.DependsOn
that may be empty.
-
getGlobal
public java.util.List<ImplementationGuide.Global> getGlobal()
A set of profiles that all resources covered by this implementation guide must conform to.- Returns:
- An unmodifiable list containing immutable objects of type
ImplementationGuide.Global
that may be empty.
-
getDefinition
public ImplementationGuide.Definition getDefinition()
The information needed by an IG publisher tool to publish the whole implementation guide.- Returns:
- An immutable object of type
ImplementationGuide.Definition
that may be null.
-
getManifest
public ImplementationGuide.Manifest getManifest()
Information about an assembled implementation guide, created by the publication tooling.- Returns:
- An immutable object of type
ImplementationGuide.Manifest
that may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public ImplementationGuide.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static ImplementationGuide.Builder builder()
-
-