
Class StructureDefinition
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.model.MetadataResource
-
- org.hl7.fhir.dstu3.model.StructureDefinition
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IAnyResource
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.IBaseResource
,org.hl7.fhir.instance.model.api.IDomainResource
public class StructureDefinition extends MetadataResource
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.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
StructureDefinition.ExtensionContext
static class
StructureDefinition.ExtensionContextEnumFactory
static class
StructureDefinition.StructureDefinitionDifferentialComponent
static class
StructureDefinition.StructureDefinitionKind
static class
StructureDefinition.StructureDefinitionKindEnumFactory
static class
StructureDefinition.StructureDefinitionMappingComponent
static class
StructureDefinition.StructureDefinitionSnapshotComponent
static class
StructureDefinition.TypeDerivationRule
static class
StructureDefinition.TypeDerivationRuleEnumFactory
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.TokenClientParam
ABSTRACT
Fluent Client search parameter constant for abstractprotected BooleanType
abstract_
Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated.static ca.uhn.fhir.rest.gclient.UriClientParam
BASE
Fluent Client search parameter constant for basestatic ca.uhn.fhir.rest.gclient.TokenClientParam
BASE_PATH
Fluent Client search parameter constant for base-pathprotected UriType
baseDefinition
An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.protected List<StringType>
context
Identifies the types of resource or data type elements to which the extension can be applied.static ca.uhn.fhir.rest.gclient.TokenClientParam
CONTEXT_TYPE
Fluent Client search parameter constant for context-typeprotected List<StringType>
contextInvariant
A set of rules as Fluent Invariants about when the extension can be used (e.g.protected Enumeration<StructureDefinition.ExtensionContext>
contextType
If this is an extension, Identifies the context within FHIR resources where the extension can be used.protected MarkdownType
copyright
A copyright statement relating to the structure definition and/or its contents.static ca.uhn.fhir.rest.gclient.DateClientParam
DATE
Fluent Client search parameter constant for dateprotected Enumeration<StructureDefinition.TypeDerivationRule>
derivation
How the type relates to the baseDefinition.static ca.uhn.fhir.rest.gclient.TokenClientParam
DERIVATION
Fluent Client search parameter constant for derivationstatic ca.uhn.fhir.rest.gclient.StringClientParam
DESCRIPTION
Fluent Client search parameter constant for descriptionprotected StructureDefinition.StructureDefinitionDifferentialComponent
differential
A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.static ca.uhn.fhir.rest.gclient.TokenClientParam
EXPERIMENTAL
Fluent Client search parameter constant for experimentalstatic ca.uhn.fhir.rest.gclient.StringClientParam
EXT_CONTEXT
Fluent Client search parameter constant for ext-contextprotected IdType
fhirVersion
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.protected List<Identifier>
identifier
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.static ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_VALUESET
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.TokenClientParam
JURISDICTION
Fluent Client search parameter constant for jurisdictionprotected List<Coding>
keyword
A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates.static ca.uhn.fhir.rest.gclient.TokenClientParam
KEYWORD
Fluent Client search parameter constant for keywordprotected Enumeration<StructureDefinition.StructureDefinitionKind>
kind
Defines the kind of structure that this definition is describing.static ca.uhn.fhir.rest.gclient.TokenClientParam
KIND
Fluent Client search parameter constant for kindprotected List<StructureDefinition.StructureDefinitionMappingComponent>
mapping
An external specification that the content is mapped to.static ca.uhn.fhir.rest.gclient.StringClientParam
NAME
Fluent Client search parameter constant for namestatic ca.uhn.fhir.rest.gclient.TokenClientParam
PATH
Fluent Client search parameter constant for pathstatic ca.uhn.fhir.rest.gclient.StringClientParam
PUBLISHER
Fluent Client search parameter constant for publisherprotected MarkdownType
purpose
Explaination of why this structure definition is needed and why it has been designed as it has.protected StructureDefinition.StructureDefinitionSnapshotComponent
snapshot
A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.static String
SP_ABSTRACT
Search parameter: abstractstatic String
SP_BASE
Search parameter: basestatic String
SP_BASE_PATH
Search parameter: base-pathstatic String
SP_CONTEXT_TYPE
Search parameter: context-typestatic String
SP_DATE
Search parameter: datestatic String
SP_DERIVATION
Search parameter: derivationstatic String
SP_DESCRIPTION
Search parameter: descriptionstatic String
SP_EXPERIMENTAL
Search parameter: experimentalstatic String
SP_EXT_CONTEXT
Search parameter: ext-contextstatic String
SP_IDENTIFIER
Search parameter: identifierstatic String
SP_JURISDICTION
Search parameter: jurisdictionstatic String
SP_KEYWORD
Search parameter: keywordstatic String
SP_KIND
Search parameter: kindstatic String
SP_NAME
Search parameter: namestatic String
SP_PATH
Search parameter: pathstatic String
SP_PUBLISHER
Search parameter: publisherstatic String
SP_STATUS
Search parameter: statusstatic String
SP_TITLE
Search parameter: titlestatic String
SP_TYPE
Search parameter: typestatic String
SP_URL
Search parameter: urlstatic String
SP_VALUESET
Search parameter: valuesetstatic String
SP_VERSION
Search parameter: versionstatic ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.StringClientParam
TITLE
Fluent Client search parameter constant for titleprotected CodeType
type
The type this structure describes.static ca.uhn.fhir.rest.gclient.TokenClientParam
TYPE
Fluent Client search parameter constant for typestatic ca.uhn.fhir.rest.gclient.UriClientParam
URL
Fluent Client search parameter constant for urlstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
VALUESET
Fluent Client search parameter constant for valuesetstatic ca.uhn.fhir.rest.gclient.TokenClientParam
VERSION
Fluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version
-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description StructureDefinition()
ConstructorStructureDefinition(UriType url, StringType name, Enumeration<Enumerations.PublicationStatus> status, Enumeration<StructureDefinition.StructureDefinitionKind> kind, BooleanType abstract_, CodeType type)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource
checkCanUseUrl, copyValues, toString
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
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.
-
purpose
protected MarkdownType purpose
Explaination of why this structure definition is needed and why it has been designed as it has.
-
copyright
protected MarkdownType copyright
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.
-
keyword
protected List<Coding> keyword
A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates.
-
fhirVersion
protected IdType fhirVersion
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 3.0.2 for this version.
-
mapping
protected List<StructureDefinition.StructureDefinitionMappingComponent> mapping
An external specification that the content is mapped to.
-
kind
protected Enumeration<StructureDefinition.StructureDefinitionKind> kind
Defines the kind of structure that this definition is describing.
-
abstract_
protected BooleanType abstract_
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.
-
contextType
protected Enumeration<StructureDefinition.ExtensionContext> contextType
If this is an extension, Identifies the context within FHIR resources where the extension can be used.
-
context
protected List<StringType> context
Identifies the types of resource or data type elements to which the extension can be applied.
-
contextInvariant
protected List<StringType> contextInvariant
A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).
-
type
protected CodeType type
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).
-
baseDefinition
protected UriType baseDefinition
An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
-
derivation
protected Enumeration<StructureDefinition.TypeDerivationRule> derivation
How the type relates to the baseDefinition.
-
snapshot
protected StructureDefinition.StructureDefinitionSnapshotComponent snapshot
A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.
-
differential
protected StructureDefinition.StructureDefinitionDifferentialComponent differential
A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: The structure definition publication date
Type: date
Path: StructureDefinition.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: The structure definition publication date
Type: date
Path: StructureDefinition.date
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: External identifier for the structure definition
Type: token
Path: StructureDefinition.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier for the structure definition
Type: token
Path: StructureDefinition.identifier
-
SP_VALUESET
public static final String SP_VALUESET
Search parameter: valuesetDescription: A vocabulary binding reference
Type: reference
Path: StructureDefinition.snapshot.element.binding.valueSet[x]
- See Also:
- Constant Field Values
-
VALUESET
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam VALUESET
Fluent Client search parameter constant for valuesetDescription: A vocabulary binding reference
Type: reference
Path: StructureDefinition.snapshot.element.binding.valueSet[x]
-
INCLUDE_VALUESET
public static final ca.uhn.fhir.model.api.Include INCLUDE_VALUESET
Constant for fluent queries to be used to add include statements. Specifies the path value of "StructureDefinition:valueset".
-
SP_KIND
public static final String SP_KIND
Search parameter: kindDescription: primitive-type | complex-type | resource | logical
Type: token
Path: StructureDefinition.kind
- See Also:
- Constant Field Values
-
KIND
public static final ca.uhn.fhir.rest.gclient.TokenClientParam KIND
Fluent Client search parameter constant for kindDescription: primitive-type | complex-type | resource | logical
Type: token
Path: StructureDefinition.kind
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the structure definition
Type: token
Path: StructureDefinition.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the structure definition
Type: token
Path: StructureDefinition.jurisdiction
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the structure definition
Type: string
Path: StructureDefinition.description
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the structure definition
Type: string
Path: StructureDefinition.description
-
SP_EXPERIMENTAL
public static final String SP_EXPERIMENTAL
Search parameter: experimentalDescription: For testing purposes, not real usage
Type: token
Path: StructureDefinition.experimental
- See Also:
- Constant Field Values
-
EXPERIMENTAL
public static final ca.uhn.fhir.rest.gclient.TokenClientParam EXPERIMENTAL
Fluent Client search parameter constant for experimentalDescription: For testing purposes, not real usage
Type: token
Path: StructureDefinition.experimental
-
SP_CONTEXT_TYPE
public static final String SP_CONTEXT_TYPE
Search parameter: context-typeDescription: resource | datatype | extension
Type: token
Path: StructureDefinition.contextType
- See Also:
- Constant Field Values
-
CONTEXT_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: resource | datatype | extension
Type: token
Path: StructureDefinition.contextType
-
SP_ABSTRACT
public static final String SP_ABSTRACT
Search parameter: abstractDescription: Whether the structure is abstract
Type: token
Path: StructureDefinition.abstract
- See Also:
- Constant Field Values
-
ABSTRACT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ABSTRACT
Fluent Client search parameter constant for abstractDescription: Whether the structure is abstract
Type: token
Path: StructureDefinition.abstract
-
SP_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: The human-friendly name of the structure definition
Type: string
Path: StructureDefinition.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the structure definition
Type: string
Path: StructureDefinition.title
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: Type defined or constrained by this structure
Type: token
Path: StructureDefinition.type
- See Also:
- Constant Field Values
-
TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
Fluent Client search parameter constant for typeDescription: Type defined or constrained by this structure
Type: token
Path: StructureDefinition.type
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: The business version of the structure definition
Type: token
Path: StructureDefinition.version
- See Also:
- Constant Field Values
-
VERSION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Fluent Client search parameter constant for versionDescription: The business version of the structure definition
Type: token
Path: StructureDefinition.version
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: The uri that identifies the structure definition
Type: uri
Path: StructureDefinition.url
- See Also:
- Constant Field Values
-
URL
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the structure definition
Type: uri
Path: StructureDefinition.url
-
SP_PATH
public static final String SP_PATH
Search parameter: pathDescription: A path that is constrained in the profile
Type: token
Path: StructureDefinition.snapshot.element.path, StructureDefinition.differential.element.path
- See Also:
- Constant Field Values
-
PATH
public static final ca.uhn.fhir.rest.gclient.TokenClientParam PATH
Fluent Client search parameter constant for pathDescription: A path that is constrained in the profile
Type: token
Path: StructureDefinition.snapshot.element.path, StructureDefinition.differential.element.path
-
SP_EXT_CONTEXT
public static final String SP_EXT_CONTEXT
Search parameter: ext-contextDescription: Where the extension can be used in instances
Type: string
Path: StructureDefinition.context
- See Also:
- Constant Field Values
-
EXT_CONTEXT
public static final ca.uhn.fhir.rest.gclient.StringClientParam EXT_CONTEXT
Fluent Client search parameter constant for ext-contextDescription: Where the extension can be used in instances
Type: string
Path: StructureDefinition.context
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: Computationally friendly name of the structure definition
Type: string
Path: StructureDefinition.name
- See Also:
- Constant Field Values
-
NAME
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the structure definition
Type: string
Path: StructureDefinition.name
-
SP_BASE_PATH
public static final String SP_BASE_PATH
Search parameter: base-pathDescription: Path that identifies the base element
Type: token
Path: StructureDefinition.snapshot.element.base.path, StructureDefinition.differential.element.base.path
- See Also:
- Constant Field Values
-
BASE_PATH
public static final ca.uhn.fhir.rest.gclient.TokenClientParam BASE_PATH
Fluent Client search parameter constant for base-pathDescription: Path that identifies the base element
Type: token
Path: StructureDefinition.snapshot.element.base.path, StructureDefinition.differential.element.base.path
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the structure definition
Type: string
Path: StructureDefinition.publisher
- See Also:
- Constant Field Values
-
PUBLISHER
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the structure definition
Type: string
Path: StructureDefinition.publisher
-
SP_DERIVATION
public static final String SP_DERIVATION
Search parameter: derivationDescription: specialization | constraint - How relates to base definition
Type: token
Path: StructureDefinition.derivation
- See Also:
- Constant Field Values
-
DERIVATION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam DERIVATION
Fluent Client search parameter constant for derivationDescription: specialization | constraint - How relates to base definition
Type: token
Path: StructureDefinition.derivation
-
SP_KEYWORD
public static final String SP_KEYWORD
Search parameter: keywordDescription: A code for the profile
Type: token
Path: StructureDefinition.keyword
- See Also:
- Constant Field Values
-
KEYWORD
public static final ca.uhn.fhir.rest.gclient.TokenClientParam KEYWORD
Fluent Client search parameter constant for keywordDescription: A code for the profile
Type: token
Path: StructureDefinition.keyword
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: The current status of the structure definition
Type: token
Path: StructureDefinition.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: The current status of the structure definition
Type: token
Path: StructureDefinition.status
-
SP_BASE
public static final String SP_BASE
Search parameter: baseDescription: Definition that this type is constrained/specialized from
Type: uri
Path: StructureDefinition.baseDefinition
- See Also:
- Constant Field Values
-
BASE
public static final ca.uhn.fhir.rest.gclient.UriClientParam BASE
Fluent Client search parameter constant for baseDescription: Definition that this type is constrained/specialized from
Type: uri
Path: StructureDefinition.baseDefinition
-
-
Constructor Detail
-
StructureDefinition
public StructureDefinition()
Constructor
-
StructureDefinition
public StructureDefinition(UriType url, StringType name, Enumeration<Enumerations.PublicationStatus> status, Enumeration<StructureDefinition.StructureDefinitionKind> kind, BooleanType abstract_, CodeType type)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Overrides:
getUrlElement
in classMetadataResource
- Returns:
MetadataResource.url
(An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure definition is (or will be) published. The URL SHOULD include the major version of the structure definition. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
- Overrides:
hasUrlElement
in classMetadataResource
-
hasUrl
public boolean hasUrl()
- Overrides:
hasUrl
in classMetadataResource
-
setUrlElement
public StructureDefinition setUrlElement(UriType value)
- Overrides:
setUrlElement
in classMetadataResource
- Parameters:
value
-MetadataResource.url
(An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure definition is (or will be) published. The URL SHOULD include the major version of the structure definition. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
public String getUrl()
- Overrides:
getUrl
in classMetadataResource
- Returns:
- An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure definition is (or will be) published. The URL SHOULD include the major version of the structure definition. For more information see [Technical and Business Versions](resource.html#versions).
-
setUrl
public StructureDefinition setUrl(String value)
- Overrides:
setUrl
in classMetadataResource
- Parameters:
value
- An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure definition is (or will be) published. The URL SHOULD include the major version of the structure definition. For more information see [Technical and Business Versions](resource.html#versions).
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier
(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.)
-
setIdentifier
public StructureDefinition setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public StructureDefinition addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getVersionElement
public StringType getVersionElement()
- Overrides:
getVersionElement
in classMetadataResource
- Returns:
MetadataResource.version
(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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
public boolean hasVersionElement()
- Overrides:
hasVersionElement
in classMetadataResource
-
hasVersion
public boolean hasVersion()
- Overrides:
hasVersion
in classMetadataResource
-
setVersionElement
public StructureDefinition setVersionElement(StringType value)
- Overrides:
setVersionElement
in classMetadataResource
- Parameters:
value
-MetadataResource.version
(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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
public String getVersion()
- Overrides:
getVersion
in classMetadataResource
- Returns:
- 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.
-
setVersion
public StructureDefinition setVersion(String value)
- Overrides:
setVersion
in classMetadataResource
- Parameters:
value
- 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.
-
getNameElement
public StringType getNameElement()
- Overrides:
getNameElement
in classMetadataResource
- Returns:
MetadataResource.name
(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.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
public boolean hasNameElement()
- Overrides:
hasNameElement
in classMetadataResource
-
hasName
public boolean hasName()
- Overrides:
hasName
in classMetadataResource
-
setNameElement
public StructureDefinition setNameElement(StringType value)
- Overrides:
setNameElement
in classMetadataResource
- Parameters:
value
-MetadataResource.name
(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.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
public String getName()
- Overrides:
getName
in classMetadataResource
- Returns:
- 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.
-
setName
public StructureDefinition setName(String value)
- Overrides:
setName
in classMetadataResource
- Parameters:
value
- 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.
-
getTitleElement
public StringType getTitleElement()
- Overrides:
getTitleElement
in classMetadataResource
- Returns:
MetadataResource.title
(A short, descriptive, user-friendly title for the structure definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
public boolean hasTitleElement()
- Overrides:
hasTitleElement
in classMetadataResource
-
hasTitle
public boolean hasTitle()
- Overrides:
hasTitle
in classMetadataResource
-
setTitleElement
public StructureDefinition setTitleElement(StringType value)
- Overrides:
setTitleElement
in classMetadataResource
- Parameters:
value
-MetadataResource.title
(A short, descriptive, user-friendly title for the structure definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
public String getTitle()
- Overrides:
getTitle
in classMetadataResource
- Returns:
- A short, descriptive, user-friendly title for the structure definition.
-
setTitle
public StructureDefinition setTitle(String value)
- Overrides:
setTitle
in classMetadataResource
- Parameters:
value
- A short, descriptive, user-friendly title for the structure definition.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Overrides:
getStatusElement
in classMetadataResource
- Returns:
MetadataResource.status
(The status of this structure definition. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
- Overrides:
hasStatusElement
in classMetadataResource
-
hasStatus
public boolean hasStatus()
- Overrides:
hasStatus
in classMetadataResource
-
setStatusElement
public StructureDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Overrides:
setStatusElement
in classMetadataResource
- Parameters:
value
-MetadataResource.status
(The status of this structure definition. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.PublicationStatus getStatus()
- Overrides:
getStatus
in classMetadataResource
- Returns:
- The status of this structure definition. Enables tracking the life-cycle of the content.
-
setStatus
public StructureDefinition setStatus(Enumerations.PublicationStatus value)
- Overrides:
setStatus
in classMetadataResource
- Parameters:
value
- The status of this structure definition. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Overrides:
getExperimentalElement
in classMetadataResource
- Returns:
MetadataResource.experimental
(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.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
hasExperimentalElement
public boolean hasExperimentalElement()
- Overrides:
hasExperimentalElement
in classMetadataResource
-
hasExperimental
public boolean hasExperimental()
- Overrides:
hasExperimental
in classMetadataResource
-
setExperimentalElement
public StructureDefinition setExperimentalElement(BooleanType value)
- Overrides:
setExperimentalElement
in classMetadataResource
- Parameters:
value
-MetadataResource.experimental
(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.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
getExperimental
public boolean getExperimental()
- Overrides:
getExperimental
in classMetadataResource
- Returns:
- 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.
-
setExperimental
public StructureDefinition setExperimental(boolean value)
- Overrides:
setExperimental
in classMetadataResource
- Parameters:
value
- 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.
-
getDateElement
public DateTimeType getDateElement()
- Overrides:
getDateElement
in classMetadataResource
- Returns:
MetadataResource.date
(The date (and optionally time) when the structure definition was published. The date must change if and 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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
- Overrides:
hasDateElement
in classMetadataResource
-
hasDate
public boolean hasDate()
- Overrides:
hasDate
in classMetadataResource
-
setDateElement
public StructureDefinition setDateElement(DateTimeType value)
- Overrides:
setDateElement
in classMetadataResource
- Parameters:
value
-MetadataResource.date
(The date (and optionally time) when the structure definition was published. The date must change if and 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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
public Date getDate()
- Overrides:
getDate
in classMetadataResource
- Returns:
- The date (and optionally time) when the structure definition was published. The date must change if and 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.
-
setDate
public StructureDefinition setDate(Date value)
- Overrides:
setDate
in classMetadataResource
- Parameters:
value
- The date (and optionally time) when the structure definition was published. The date must change if and 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.
-
getPublisherElement
public StringType getPublisherElement()
- Overrides:
getPublisherElement
in classMetadataResource
- Returns:
MetadataResource.publisher
(The name of the individual or organization that published the structure definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
public boolean hasPublisherElement()
- Overrides:
hasPublisherElement
in classMetadataResource
-
hasPublisher
public boolean hasPublisher()
- Overrides:
hasPublisher
in classMetadataResource
-
setPublisherElement
public StructureDefinition setPublisherElement(StringType value)
- Overrides:
setPublisherElement
in classMetadataResource
- Parameters:
value
-MetadataResource.publisher
(The name of the individual or organization that published the structure definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
public String getPublisher()
- Overrides:
getPublisher
in classMetadataResource
- Returns:
- The name of the individual or organization that published the structure definition.
-
setPublisher
public StructureDefinition setPublisher(String value)
- Overrides:
setPublisher
in classMetadataResource
- Parameters:
value
- The name of the individual or organization that published the structure definition.
-
getContact
public List<ContactDetail> getContact()
- Overrides:
getContact
in classMetadataResource
- Returns:
MetadataResource.contact
(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public StructureDefinition setContact(List<ContactDetail> theContact)
- Overrides:
setContact
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
public boolean hasContact()
- Overrides:
hasContact
in classMetadataResource
-
addContact
public ContactDetail addContact()
- Overrides:
addContact
in classMetadataResource
-
addContact
public StructureDefinition addContact(ContactDetail t)
- Overrides:
addContact
in classMetadataResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Overrides:
getContactFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.contact
, creating it if it does not already exist
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Overrides:
getDescriptionElement
in classMetadataResource
- Returns:
MetadataResource.description
(A free text natural language description of the structure definition from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
public boolean hasDescriptionElement()
- Overrides:
hasDescriptionElement
in classMetadataResource
-
hasDescription
public boolean hasDescription()
- Overrides:
hasDescription
in classMetadataResource
-
setDescriptionElement
public StructureDefinition setDescriptionElement(MarkdownType value)
- Overrides:
setDescriptionElement
in classMetadataResource
- Parameters:
value
-MetadataResource.description
(A free text natural language description of the structure definition from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Overrides:
getDescription
in classMetadataResource
- Returns:
- A free text natural language description of the structure definition from a consumer's perspective.
-
setDescription
public StructureDefinition setDescription(String value)
- Overrides:
setDescription
in classMetadataResource
- Parameters:
value
- A free text natural language description of the structure definition from a consumer's perspective.
-
getUseContext
public List<UsageContext> getUseContext()
- Overrides:
getUseContext
in classMetadataResource
- Returns:
MetadataResource.useContext
(The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate structure definition instances.)
-
setUseContext
public StructureDefinition setUseContext(List<UsageContext> theUseContext)
- Overrides:
setUseContext
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Overrides:
hasUseContext
in classMetadataResource
-
addUseContext
public UsageContext addUseContext()
- Overrides:
addUseContext
in classMetadataResource
-
addUseContext
public StructureDefinition addUseContext(UsageContext t)
- Overrides:
addUseContext
in classMetadataResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Overrides:
getUseContextFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.useContext
, creating it if it does not already exist
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Overrides:
getJurisdiction
in classMetadataResource
- Returns:
MetadataResource.jurisdiction
(A legal or geographic region in which the structure definition is intended to be used.)
-
setJurisdiction
public StructureDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)
- Overrides:
setJurisdiction
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Overrides:
hasJurisdiction
in classMetadataResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Overrides:
addJurisdiction
in classMetadataResource
-
addJurisdiction
public StructureDefinition addJurisdiction(CodeableConcept t)
- Overrides:
addJurisdiction
in classMetadataResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Overrides:
getJurisdictionFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction
, creating it if it does not already exist
-
getPurposeElement
public MarkdownType getPurposeElement()
- Returns:
purpose
(Explaination of why this structure definition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
hasPurposeElement
public boolean hasPurposeElement()
-
hasPurpose
public boolean hasPurpose()
-
setPurposeElement
public StructureDefinition setPurposeElement(MarkdownType value)
- Parameters:
value
-purpose
(Explaination of why this structure definition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
getPurpose
public String getPurpose()
- Returns:
- Explaination of why this structure definition is needed and why it has been designed as it has.
-
setPurpose
public StructureDefinition setPurpose(String value)
- Parameters:
value
- Explaination of why this structure definition is needed and why it has been designed as it has.
-
getCopyrightElement
public MarkdownType getCopyrightElement()
- Returns:
copyright
(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.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
hasCopyrightElement
public boolean hasCopyrightElement()
-
hasCopyright
public boolean hasCopyright()
-
setCopyrightElement
public StructureDefinition setCopyrightElement(MarkdownType value)
- Parameters:
value
-copyright
(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.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
getCopyright
public String getCopyright()
- Returns:
- 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.
-
setCopyright
public StructureDefinition setCopyright(String value)
- Parameters:
value
- 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.
-
getKeyword
public List<Coding> getKeyword()
- Returns:
keyword
(A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates.)
-
setKeyword
public StructureDefinition setKeyword(List<Coding> theKeyword)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasKeyword
public boolean hasKeyword()
-
addKeyword
public Coding addKeyword()
-
addKeyword
public StructureDefinition addKeyword(Coding t)
-
getKeywordFirstRep
public Coding getKeywordFirstRep()
- Returns:
- The first repetition of repeating field
keyword
, creating it if it does not already exist
-
getFhirVersionElement
public IdType getFhirVersionElement()
- Returns:
fhirVersion
(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 3.0.2 for this version.). This is the underlying object with id, value and extensions. The accessor "getFhirVersion" gives direct access to the value
-
hasFhirVersionElement
public boolean hasFhirVersionElement()
-
hasFhirVersion
public boolean hasFhirVersion()
-
setFhirVersionElement
public StructureDefinition setFhirVersionElement(IdType value)
- Parameters:
value
-fhirVersion
(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 3.0.2 for this version.). This is the underlying object with id, value and extensions. The accessor "getFhirVersion" gives direct access to the value
-
getFhirVersion
public String getFhirVersion()
- Returns:
- 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 3.0.2 for this version.
-
setFhirVersion
public StructureDefinition setFhirVersion(String value)
- Parameters:
value
- 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 3.0.2 for this version.
-
getMapping
public List<StructureDefinition.StructureDefinitionMappingComponent> getMapping()
- Returns:
mapping
(An external specification that the content is mapped to.)
-
setMapping
public StructureDefinition setMapping(List<StructureDefinition.StructureDefinitionMappingComponent> theMapping)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasMapping
public boolean hasMapping()
-
addMapping
public StructureDefinition.StructureDefinitionMappingComponent addMapping()
-
addMapping
public StructureDefinition addMapping(StructureDefinition.StructureDefinitionMappingComponent t)
-
getMappingFirstRep
public StructureDefinition.StructureDefinitionMappingComponent getMappingFirstRep()
- Returns:
- The first repetition of repeating field
mapping
, creating it if it does not already exist
-
getKindElement
public Enumeration<StructureDefinition.StructureDefinitionKind> getKindElement()
- Returns:
kind
(Defines the kind of structure that this definition is describing.). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value
-
hasKindElement
public boolean hasKindElement()
-
hasKind
public boolean hasKind()
-
setKindElement
public StructureDefinition setKindElement(Enumeration<StructureDefinition.StructureDefinitionKind> value)
- Parameters:
value
-kind
(Defines the kind of structure that this definition is describing.). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value
-
getKind
public StructureDefinition.StructureDefinitionKind getKind()
- Returns:
- Defines the kind of structure that this definition is describing.
-
setKind
public StructureDefinition setKind(StructureDefinition.StructureDefinitionKind value)
- Parameters:
value
- Defines the kind of structure that this definition is describing.
-
getAbstractElement
public BooleanType getAbstractElement()
- Returns:
abstract_
(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.). This is the underlying object with id, value and extensions. The accessor "getAbstract" gives direct access to the value
-
hasAbstractElement
public boolean hasAbstractElement()
-
hasAbstract
public boolean hasAbstract()
-
setAbstractElement
public StructureDefinition setAbstractElement(BooleanType value)
- Parameters:
value
-abstract_
(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.). This is the underlying object with id, value and extensions. The accessor "getAbstract" gives direct access to the value
-
getAbstract
public boolean getAbstract()
- Returns:
- 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.
-
setAbstract
public StructureDefinition setAbstract(boolean value)
- Parameters:
value
- 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.
-
getContextTypeElement
public Enumeration<StructureDefinition.ExtensionContext> getContextTypeElement()
- Returns:
contextType
(If this is an extension, Identifies the context within FHIR resources where the extension can be used.). This is the underlying object with id, value and extensions. The accessor "getContextType" gives direct access to the value
-
hasContextTypeElement
public boolean hasContextTypeElement()
-
hasContextType
public boolean hasContextType()
-
setContextTypeElement
public StructureDefinition setContextTypeElement(Enumeration<StructureDefinition.ExtensionContext> value)
- Parameters:
value
-contextType
(If this is an extension, Identifies the context within FHIR resources where the extension can be used.). This is the underlying object with id, value and extensions. The accessor "getContextType" gives direct access to the value
-
getContextType
public StructureDefinition.ExtensionContext getContextType()
- Returns:
- If this is an extension, Identifies the context within FHIR resources where the extension can be used.
-
setContextType
public StructureDefinition setContextType(StructureDefinition.ExtensionContext value)
- Parameters:
value
- If this is an extension, Identifies the context within FHIR resources where the extension can be used.
-
getContext
public List<StringType> getContext()
- Returns:
context
(Identifies the types of resource or data type elements to which the extension can be applied.)
-
setContext
public StructureDefinition setContext(List<StringType> theContext)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContext
public boolean hasContext()
-
addContextElement
public StringType addContextElement()
- Returns:
context
(Identifies the types of resource or data type elements to which the extension can be applied.)
-
addContext
public StructureDefinition addContext(String value)
- Parameters:
value
-context
(Identifies the types of resource or data type elements to which the extension can be applied.)
-
hasContext
public boolean hasContext(String value)
- Parameters:
value
-context
(Identifies the types of resource or data type elements to which the extension can be applied.)
-
getContextInvariant
public List<StringType> getContextInvariant()
- Returns:
contextInvariant
(A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).)
-
setContextInvariant
public StructureDefinition setContextInvariant(List<StringType> theContextInvariant)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContextInvariant
public boolean hasContextInvariant()
-
addContextInvariantElement
public StringType addContextInvariantElement()
- Returns:
contextInvariant
(A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).)
-
addContextInvariant
public StructureDefinition addContextInvariant(String value)
- Parameters:
value
-contextInvariant
(A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).)
-
hasContextInvariant
public boolean hasContextInvariant(String value)
- Parameters:
value
-contextInvariant
(A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).)
-
getTypeElement
public CodeType getTypeElement()
- Returns:
type
(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).). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
hasTypeElement
public boolean hasTypeElement()
-
hasType
public boolean hasType()
-
setTypeElement
public StructureDefinition setTypeElement(CodeType value)
- Parameters:
value
-type
(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).). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
getType
public String getType()
- Returns:
- 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).
-
setType
public StructureDefinition setType(String value)
- Parameters:
value
- 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).
-
getBaseDefinitionElement
public UriType getBaseDefinitionElement()
- Returns:
baseDefinition
(An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.). This is the underlying object with id, value and extensions. The accessor "getBaseDefinition" gives direct access to the value
-
hasBaseDefinitionElement
public boolean hasBaseDefinitionElement()
-
hasBaseDefinition
public boolean hasBaseDefinition()
-
setBaseDefinitionElement
public StructureDefinition setBaseDefinitionElement(UriType value)
- Parameters:
value
-baseDefinition
(An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.). This is the underlying object with id, value and extensions. The accessor "getBaseDefinition" gives direct access to the value
-
getBaseDefinition
public String getBaseDefinition()
- Returns:
- An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
-
setBaseDefinition
public StructureDefinition setBaseDefinition(String value)
- Parameters:
value
- An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
-
getDerivationElement
public Enumeration<StructureDefinition.TypeDerivationRule> getDerivationElement()
- Returns:
derivation
(How the type relates to the baseDefinition.). This is the underlying object with id, value and extensions. The accessor "getDerivation" gives direct access to the value
-
hasDerivationElement
public boolean hasDerivationElement()
-
hasDerivation
public boolean hasDerivation()
-
setDerivationElement
public StructureDefinition setDerivationElement(Enumeration<StructureDefinition.TypeDerivationRule> value)
- Parameters:
value
-derivation
(How the type relates to the baseDefinition.). This is the underlying object with id, value and extensions. The accessor "getDerivation" gives direct access to the value
-
getDerivation
public StructureDefinition.TypeDerivationRule getDerivation()
- Returns:
- How the type relates to the baseDefinition.
-
setDerivation
public StructureDefinition setDerivation(StructureDefinition.TypeDerivationRule value)
- Parameters:
value
- How the type relates to the baseDefinition.
-
getSnapshot
public StructureDefinition.StructureDefinitionSnapshotComponent getSnapshot()
- Returns:
snapshot
(A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.)
-
hasSnapshot
public boolean hasSnapshot()
-
setSnapshot
public StructureDefinition setSnapshot(StructureDefinition.StructureDefinitionSnapshotComponent value)
- Parameters:
value
-snapshot
(A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.)
-
getDifferential
public StructureDefinition.StructureDefinitionDifferentialComponent getDifferential()
- Returns:
differential
(A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.)
-
hasDifferential
public boolean hasDifferential()
-
setDifferential
public StructureDefinition setDifferential(StructureDefinition.StructureDefinitionDifferentialComponent value)
- Parameters:
value
-differential
(A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classMetadataResource
-
copy
public StructureDefinition copy()
- Specified by:
copy
in classMetadataResource
-
typedCopy
protected StructureDefinition typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classMetadataResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classMetadataResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classMetadataResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-