Class StructureDefinition
- 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.StructureDefinition
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class StructureDefinition extends DomainResource
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.Maturity level: FMM5 (Normative)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
StructureDefinition.Builder
static class
StructureDefinition.Context
Identifies the types of resource or data type elements to which the extension can be applied.static class
StructureDefinition.Differential
A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.static class
StructureDefinition.Mapping
An external specification that the content is mapped to.static class
StructureDefinition.Snapshot
A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.
-
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 StructureDefinition.Builder
builder()
boolean
equals(java.lang.Object obj)
Boolean
getAbstract()
Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated.Canonical
getBaseDefinition()
An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.java.util.List<ContactDetail>
getContact()
Contact details to assist a user in finding and communicating with the publisher.java.util.List<StructureDefinition.Context>
getContext()
Identifies the types of resource or data type elements to which the extension can be applied.java.util.List<String>
getContextInvariant()
A set of rules as FHIRPath Invariants about when the extension can be used (e.g.Markdown
getCopyright()
A copyright statement relating to the structure definition and/or its contents.DateTime
getDate()
The date (and optionally time) when the structure definition was published.TypeDerivationRule
getDerivation()
How the type relates to the baseDefinition.Markdown
getDescription()
A free text natural language description of the structure definition from a consumer's perspective.StructureDefinition.Differential
getDifferential()
A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.Boolean
getExperimental()
A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.FHIRVersion
getFhirVersion()
The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g.java.util.List<Identifier>
getIdentifier()
A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.java.util.List<CodeableConcept>
getJurisdiction()
A legal or geographic region in which the structure definition is intended to be used.java.util.List<Coding>
getKeyword()
A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.StructureDefinitionKind
getKind()
Defines the kind of structure that this definition is describing.java.util.List<StructureDefinition.Mapping>
getMapping()
An external specification that the content is mapped to.String
getName()
A natural language name identifying the structure definition.String
getPublisher()
The name of the organization or individual that published the structure definition.Markdown
getPurpose()
Explanation of why this structure definition is needed and why it has been designed as it has.StructureDefinition.Snapshot
getSnapshot()
A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.PublicationStatus
getStatus()
The status of this structure definition.String
getTitle()
A short, descriptive, user-friendly title for the structure definition.Uri
getType()
The type this structure describes.Uri
getUrl()
An absolute URI that is used to identify this structure definition 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 structure definition when it is referenced in a specification, model, design or instance.boolean
hasChildren()
int
hashCode()
StructureDefinition.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 structure definition 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 definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure definition is stored on different servers.- Returns:
- An immutable object of type
Uri
that is non-null.
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getVersion
public String getVersion()
The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition 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 structure definition. 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 structure definition.- Returns:
- An immutable object of type
String
that may be null.
-
getStatus
public PublicationStatus getStatus()
The status of this structure definition. 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 structure definition 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 structure definition 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 definition 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 structure definition.- 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 structure definition 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 structure definition 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 structure definition is intended to be used.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getPurpose
public Markdown getPurpose()
Explanation of why this structure definition is needed and why it has been designed as it has.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getCopyright
public Markdown getCopyright()
A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getKeyword
public java.util.List<Coding> getKeyword()
A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.- Returns:
- An unmodifiable list containing immutable objects of type
Coding
that may be empty.
-
getFhirVersion
public FHIRVersion getFhirVersion()
The version of the FHIR specification on which this StructureDefinition is based - this 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 immutable object of type
FHIRVersion
that may be null.
-
getMapping
public java.util.List<StructureDefinition.Mapping> getMapping()
An external specification that the content is mapped to.- Returns:
- An unmodifiable list containing immutable objects of type
StructureDefinition.Mapping
that may be empty.
-
getKind
public StructureDefinitionKind getKind()
Defines the kind of structure that this definition is describing.- Returns:
- An immutable object of type
StructureDefinitionKind
that is non-null.
-
getAbstract
public Boolean getAbstract()
Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.- Returns:
- An immutable object of type
Boolean
that is non-null.
-
getContext
public java.util.List<StructureDefinition.Context> getContext()
Identifies the types of resource or data type elements to which the extension can be applied.- Returns:
- An unmodifiable list containing immutable objects of type
StructureDefinition.Context
that may be empty.
-
getContextInvariant
public java.util.List<String> getContextInvariant()
A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.- Returns:
- An unmodifiable list containing immutable objects of type
String
that may be empty.
-
getType
public Uri getType()
The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http: //hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.- Returns:
- An immutable object of type
Uri
that is non-null.
-
getBaseDefinition
public Canonical getBaseDefinition()
An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.- Returns:
- An immutable object of type
Canonical
that may be null.
-
getDerivation
public TypeDerivationRule getDerivation()
How the type relates to the baseDefinition.- Returns:
- An immutable object of type
TypeDerivationRule
that may be null.
-
getSnapshot
public StructureDefinition.Snapshot getSnapshot()
A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.- Returns:
- An immutable object of type
StructureDefinition.Snapshot
that may be null.
-
getDifferential
public StructureDefinition.Differential getDifferential()
A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.- Returns:
- An immutable object of type
StructureDefinition.Differential
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 StructureDefinition.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 StructureDefinition.Builder builder()
-
-