public class StructureDefinition extends MetadataResource
| Modifier and Type | Class and Description |
|---|---|
static class |
StructureDefinition.ExtensionContextType |
static class |
StructureDefinition.ExtensionContextTypeEnumFactory |
static class |
StructureDefinition.StructureDefinitionContextComponent |
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 |
| Modifier and Type | Field and Description |
|---|---|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
ABSTRACT
Fluent Client search parameter constant for abstract
|
protected 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.ReferenceClientParam |
BASE
Fluent Client search parameter constant for base
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
BASE_PATH
Fluent Client search parameter constant for base-path
|
protected CanonicalType |
baseDefinition
An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
|
protected List<StructureDefinition.StructureDefinitionContextComponent> |
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
Fluent Client search parameter constant for context
|
static ca.uhn.fhir.rest.gclient.QuantityClientParam |
CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantity
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
CONTEXT_TYPE
Fluent Client search parameter constant for context-type
|
static ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> |
CONTEXT_TYPE_QUANTITY
Fluent Client search parameter constant for context-type-quantity
|
static ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> |
CONTEXT_TYPE_VALUE
Fluent Client search parameter constant for context-type-value
|
protected List<StringType> |
contextInvariant
A set of rules as FHIRPath Invariants about when the extension can be used (e.g.
|
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 date
|
protected 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 derivation
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
DESCRIPTION
Fluent Client search parameter constant for description
|
protected 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 experimental
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
EXT_CONTEXT
Fluent Client search parameter constant for ext-context
|
protected Enumeration<Enumerations.FHIRVersion> |
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 identifier
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_BASE
Constant for fluent queries to be used to add include statements.
|
static 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 jurisdiction
|
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 nby describing the use of this structure definition, or the content it describes.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
KEYWORD
Fluent Client search parameter constant for keyword
|
protected 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 kind
|
protected 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 name
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
PATH
Fluent Client search parameter constant for path
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
PUBLISHER
Fluent Client search parameter constant for publisher
|
protected MarkdownType |
purpose
Explanation 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 standalone form that can be used and interpreted without considering the base StructureDefinition.
|
static String |
SP_ABSTRACT
Search parameter: abstract
|
static String |
SP_BASE
Search parameter: base
|
static String |
SP_BASE_PATH
Search parameter: base-path
|
static String |
SP_CONTEXT
Search parameter: context
|
static String |
SP_CONTEXT_QUANTITY
Search parameter: context-quantity
|
static String |
SP_CONTEXT_TYPE
Search parameter: context-type
|
static String |
SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantity
|
static String |
SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-value
|
static String |
SP_DATE
Search parameter: date
|
static String |
SP_DERIVATION
Search parameter: derivation
|
static String |
SP_DESCRIPTION
Search parameter: description
|
static String |
SP_EXPERIMENTAL
Search parameter: experimental
|
static String |
SP_EXT_CONTEXT
Search parameter: ext-context
|
static String |
SP_IDENTIFIER
Search parameter: identifier
|
static String |
SP_JURISDICTION
Search parameter: jurisdiction
|
static String |
SP_KEYWORD
Search parameter: keyword
|
static String |
SP_KIND
Search parameter: kind
|
static String |
SP_NAME
Search parameter: name
|
static String |
SP_PATH
Search parameter: path
|
static String |
SP_PUBLISHER
Search parameter: publisher
|
static String |
SP_STATUS
Search parameter: status
|
static String |
SP_TITLE
Search parameter: title
|
static String |
SP_TYPE
Search parameter: type
|
static String |
SP_URL
Search parameter: url
|
static String |
SP_VALUESET
Search parameter: valueset
|
static String |
SP_VERSION
Search parameter: version
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
TITLE
Fluent Client search parameter constant for title
|
protected UriType |
type
The type this structure describes.
|
static ca.uhn.fhir.rest.gclient.UriClientParam |
TYPE
Fluent Client search parameter constant for type
|
static ca.uhn.fhir.rest.gclient.UriClientParam |
URL
Fluent Client search parameter constant for url
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
VALUESET
Fluent Client search parameter constant for valueset
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
VERSION
Fluent Client search parameter constant for version
|
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, versioncontained, extension, modifierExtension, textid, implicitRules, language, meta| Constructor and Description |
|---|
StructureDefinition()
Constructor
|
StructureDefinition(UriType url,
StringType name,
Enumeration<Enumerations.PublicationStatus> status,
Enumeration<StructureDefinition.StructureDefinitionKind> kind,
BooleanType abstract_,
UriType type)
Constructor
|
copyValues, present, toStringaddContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setTextcopyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, isResource, setIdcastToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataprotected List<Identifier> identifier
protected MarkdownType purpose
protected MarkdownType copyright
protected List<Coding> keyword
protected Enumeration<Enumerations.FHIRVersion> fhirVersion
protected List<StructureDefinition.StructureDefinitionMappingComponent> mapping
protected Enumeration<StructureDefinition.StructureDefinitionKind> kind
protected BooleanType abstract_
protected List<StructureDefinition.StructureDefinitionContextComponent> context
protected List<StringType> contextInvariant
protected UriType type
protected CanonicalType baseDefinition
protected Enumeration<StructureDefinition.TypeDerivationRule> derivation
protected StructureDefinition.StructureDefinitionSnapshotComponent snapshot
protected StructureDefinition.StructureDefinitionDifferentialComponent differential
public static final String SP_DATE
Description: The structure definition publication date
Type: date
Path: StructureDefinition.date
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Description: The structure definition publication date
Type: date
Path: StructureDefinition.date
public static final String SP_CONTEXT_TYPE_VALUE
Description: A use context type and value assigned to the structure definition
Type: composite
Path:
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
Description: A use context type and value assigned to the structure definition
Type: composite
Path:
public static final String SP_JURISDICTION
Description: Intended jurisdiction for the structure definition
Type: token
Path: StructureDefinition.jurisdiction
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Description: Intended jurisdiction for the structure definition
Type: token
Path: StructureDefinition.jurisdiction
public static final String SP_DESCRIPTION
Description: The description of the structure definition
Type: string
Path: StructureDefinition.description
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Description: The description of the structure definition
Type: string
Path: StructureDefinition.description
public static final String SP_CONTEXT_TYPE
Description: A type of use context assigned to the structure definition
Type: token
Path: StructureDefinition.useContext.code
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
Description: A type of use context assigned to the structure definition
Type: token
Path: StructureDefinition.useContext.code
public static final String SP_EXPERIMENTAL
Description: For testing purposes, not real usage
Type: token
Path: StructureDefinition.experimental
public static final ca.uhn.fhir.rest.gclient.TokenClientParam EXPERIMENTAL
Description: For testing purposes, not real usage
Type: token
Path: StructureDefinition.experimental
public static final String SP_TITLE
Description: The human-friendly name of the structure definition
Type: string
Path: StructureDefinition.title
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Description: The human-friendly name of the structure definition
Type: string
Path: StructureDefinition.title
public static final String SP_TYPE
Description: Type defined or constrained by this structure
Type: uri
Path: StructureDefinition.type
public static final ca.uhn.fhir.rest.gclient.UriClientParam TYPE
Description: Type defined or constrained by this structure
Type: uri
Path: StructureDefinition.type
public static final String SP_CONTEXT_QUANTITY
Description: A quantity- or range-valued use context assigned to the structure definition
Type: quantity
Path: StructureDefinition.useContext.valueQuantity, StructureDefinition.useContext.valueRange
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
Description: A quantity- or range-valued use context assigned to the structure definition
Type: quantity
Path: StructureDefinition.useContext.valueQuantity, StructureDefinition.useContext.valueRange
public static final String SP_PATH
Description: A path that is constrained in the StructureDefinition
Type: token
Path: StructureDefinition.snapshot.element.path, StructureDefinition.differential.element.path
public static final ca.uhn.fhir.rest.gclient.TokenClientParam PATH
Description: A path that is constrained in the StructureDefinition
Type: token
Path: StructureDefinition.snapshot.element.path, StructureDefinition.differential.element.path
public static final String SP_CONTEXT
Description: A use context assigned to the structure definition
Type: token
Path: StructureDefinition.useContext.valueCodeableConcept
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
Description: A use context assigned to the structure definition
Type: token
Path: StructureDefinition.useContext.valueCodeableConcept
public static final String SP_BASE_PATH
Description: Path that identifies the base element
Type: token
Path: StructureDefinition.snapshot.element.base.path, StructureDefinition.differential.element.base.path
public static final ca.uhn.fhir.rest.gclient.TokenClientParam BASE_PATH
Description: Path that identifies the base element
Type: token
Path: StructureDefinition.snapshot.element.base.path, StructureDefinition.differential.element.base.path
public static final String SP_KEYWORD
Description: A code for the StructureDefinition
Type: token
Path: StructureDefinition.keyword
public static final ca.uhn.fhir.rest.gclient.TokenClientParam KEYWORD
Description: A code for the StructureDefinition
Type: token
Path: StructureDefinition.keyword
public static final String SP_CONTEXT_TYPE_QUANTITY
Description: A use context type and quantity- or range-based value assigned to the structure definition
Type: composite
Path:
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
Description: A use context type and quantity- or range-based value assigned to the structure definition
Type: composite
Path:
public static final String SP_IDENTIFIER
Description: External identifier for the structure definition
Type: token
Path: StructureDefinition.identifier
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Description: External identifier for the structure definition
Type: token
Path: StructureDefinition.identifier
public static final String SP_VALUESET
Description: A vocabulary binding reference
Type: reference
Path: StructureDefinition.snapshot.element.binding.valueSet
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam VALUESET
Description: A vocabulary binding reference
Type: reference
Path: StructureDefinition.snapshot.element.binding.valueSet
public static final ca.uhn.fhir.model.api.Include INCLUDE_VALUESET
public static final String SP_KIND
Description: primitive-type | complex-type | resource | logical
Type: token
Path: StructureDefinition.kind
public static final ca.uhn.fhir.rest.gclient.TokenClientParam KIND
Description: primitive-type | complex-type | resource | logical
Type: token
Path: StructureDefinition.kind
public static final String SP_ABSTRACT
Description: Whether the structure is abstract
Type: token
Path: StructureDefinition.abstract
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ABSTRACT
Description: Whether the structure is abstract
Type: token
Path: StructureDefinition.abstract
public static final String SP_VERSION
Description: The business version of the structure definition
Type: token
Path: StructureDefinition.version
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Description: The business version of the structure definition
Type: token
Path: StructureDefinition.version
public static final String SP_URL
Description: The uri that identifies the structure definition
Type: uri
Path: StructureDefinition.url
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Description: The uri that identifies the structure definition
Type: uri
Path: StructureDefinition.url
public static final String SP_EXT_CONTEXT
Description: The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text
Type: token
Path: StructureDefinition.context.type
public static final ca.uhn.fhir.rest.gclient.TokenClientParam EXT_CONTEXT
Description: The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text
Type: token
Path: StructureDefinition.context.type
public static final String SP_NAME
Description: Computationally friendly name of the structure definition
Type: string
Path: StructureDefinition.name
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Description: Computationally friendly name of the structure definition
Type: string
Path: StructureDefinition.name
public static final String SP_PUBLISHER
Description: Name of the publisher of the structure definition
Type: string
Path: StructureDefinition.publisher
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
Description: Name of the publisher of the structure definition
Type: string
Path: StructureDefinition.publisher
public static final String SP_DERIVATION
Description: specialization | constraint - How relates to base definition
Type: token
Path: StructureDefinition.derivation
public static final ca.uhn.fhir.rest.gclient.TokenClientParam DERIVATION
Description: specialization | constraint - How relates to base definition
Type: token
Path: StructureDefinition.derivation
public static final String SP_STATUS
Description: The current status of the structure definition
Type: token
Path: StructureDefinition.status
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Description: The current status of the structure definition
Type: token
Path: StructureDefinition.status
public static final String SP_BASE
Description: Definition that this type is constrained/specialized from
Type: reference
Path: StructureDefinition.baseDefinition
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASE
Description: Definition that this type is constrained/specialized from
Type: reference
Path: StructureDefinition.baseDefinition
public static final ca.uhn.fhir.model.api.Include INCLUDE_BASE
public StructureDefinition()
public StructureDefinition(UriType url, StringType name, Enumeration<Enumerations.PublicationStatus> status, Enumeration<StructureDefinition.StructureDefinitionKind> kind, BooleanType abstract_, UriType type)
public UriType getUrlElement()
getUrlElement in class MetadataResourceMetadataResource.url (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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the valuepublic boolean hasUrlElement()
hasUrlElement in class MetadataResourcepublic boolean hasUrl()
hasUrl in class MetadataResourcepublic StructureDefinition setUrlElement(UriType value)
setUrlElement in class MetadataResourcevalue - 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; 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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the valuepublic String getUrl()
getUrl in class MetadataResourcepublic StructureDefinition setUrl(String value)
setUrl in class MetadataResourcevalue - 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.public List<Identifier> getIdentifier()
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.)public StructureDefinition setIdentifier(List<Identifier> theIdentifier)
this for easy method chainingpublic boolean hasIdentifier()
public Identifier addIdentifier()
public StructureDefinition addIdentifier(Identifier t)
public Identifier getIdentifierFirstRep()
identifier, creating it if it does not already existpublic StringType getVersionElement()
getVersionElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasVersionElement()
hasVersionElement in class MetadataResourcepublic boolean hasVersion()
hasVersion in class MetadataResourcepublic StructureDefinition setVersionElement(StringType value)
setVersionElement in class MetadataResourcevalue - 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 valuepublic String getVersion()
getVersion in class MetadataResourcepublic StructureDefinition setVersion(String value)
setVersion in class MetadataResourcevalue - 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.public StringType getNameElement()
getNameElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasNameElement()
hasNameElement in class MetadataResourcepublic boolean hasName()
hasName in class MetadataResourcepublic StructureDefinition setNameElement(StringType value)
setNameElement in class MetadataResourcevalue - 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 valuepublic String getName()
getName in class MetadataResourcepublic StructureDefinition setName(String value)
setName in class MetadataResourcevalue - 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.public StringType getTitleElement()
getTitleElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasTitleElement()
hasTitleElement in class MetadataResourcepublic boolean hasTitle()
hasTitle in class MetadataResourcepublic StructureDefinition setTitleElement(StringType value)
setTitleElement in class MetadataResourcevalue - 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 valuepublic String getTitle()
getTitle in class MetadataResourcepublic StructureDefinition setTitle(String value)
setTitle in class MetadataResourcevalue - A short, descriptive, user-friendly title for the structure definition.public Enumeration<Enumerations.PublicationStatus> getStatusElement()
getStatusElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasStatusElement()
hasStatusElement in class MetadataResourcepublic boolean hasStatus()
hasStatus in class MetadataResourcepublic StructureDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
setStatusElement in class MetadataResourcevalue - 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 valuepublic Enumerations.PublicationStatus getStatus()
getStatus in class MetadataResourcepublic StructureDefinition setStatus(Enumerations.PublicationStatus value)
setStatus in class MetadataResourcevalue - The status of this structure definition. Enables tracking the life-cycle of the content.public BooleanType getExperimentalElement()
getExperimentalElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasExperimentalElement()
hasExperimentalElement in class MetadataResourcepublic boolean hasExperimental()
hasExperimental in class MetadataResourcepublic StructureDefinition setExperimentalElement(BooleanType value)
setExperimentalElement in class MetadataResourcevalue - 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 valuepublic boolean getExperimental()
getExperimental in class MetadataResourcepublic StructureDefinition setExperimental(boolean value)
setExperimental in class MetadataResourcevalue - 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.public DateTimeType getDateElement()
getDateElement in class MetadataResourceMetadataResource.date (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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the valuepublic boolean hasDateElement()
hasDateElement in class MetadataResourcepublic boolean hasDate()
hasDate in class MetadataResourcepublic StructureDefinition setDateElement(DateTimeType value)
setDateElement in class MetadataResourcevalue - MetadataResource.date (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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the valuepublic Date getDate()
getDate in class MetadataResourcepublic StructureDefinition setDate(Date value)
setDate in class MetadataResourcevalue - 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.public StringType getPublisherElement()
getPublisherElement in class MetadataResourceMetadataResource.publisher (The name of the organization or individual that published the structure definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the valuepublic boolean hasPublisherElement()
hasPublisherElement in class MetadataResourcepublic boolean hasPublisher()
hasPublisher in class MetadataResourcepublic StructureDefinition setPublisherElement(StringType value)
setPublisherElement in class MetadataResourcevalue - MetadataResource.publisher (The name of the organization or individual that published the structure definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the valuepublic String getPublisher()
getPublisher in class MetadataResourcepublic StructureDefinition setPublisher(String value)
setPublisher in class MetadataResourcevalue - The name of the organization or individual that published the structure definition.public List<ContactDetail> getContact()
getContact in class MetadataResourceMetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)public StructureDefinition setContact(List<ContactDetail> theContact)
setContact in class MetadataResourcethis for easy method chainingpublic boolean hasContact()
hasContact in class MetadataResourcepublic ContactDetail addContact()
addContact in class MetadataResourcepublic StructureDefinition addContact(ContactDetail t)
addContact in class MetadataResourcepublic ContactDetail getContactFirstRep()
getContactFirstRep in class MetadataResourceMetadataResource.contact, creating it if it does not already existpublic MarkdownType getDescriptionElement()
getDescriptionElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasDescriptionElement()
hasDescriptionElement in class MetadataResourcepublic boolean hasDescription()
hasDescription in class MetadataResourcepublic StructureDefinition setDescriptionElement(MarkdownType value)
setDescriptionElement in class MetadataResourcevalue - 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 valuepublic String getDescription()
getDescription in class MetadataResourcepublic StructureDefinition setDescription(String value)
setDescription in class MetadataResourcevalue - A free text natural language description of the structure definition from a consumer's perspective.public List<UsageContext> getUseContext()
getUseContext in class MetadataResourceMetadataResource.useContext (The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure definition instances.)public StructureDefinition setUseContext(List<UsageContext> theUseContext)
setUseContext in class MetadataResourcethis for easy method chainingpublic boolean hasUseContext()
hasUseContext in class MetadataResourcepublic UsageContext addUseContext()
addUseContext in class MetadataResourcepublic StructureDefinition addUseContext(UsageContext t)
addUseContext in class MetadataResourcepublic UsageContext getUseContextFirstRep()
getUseContextFirstRep in class MetadataResourceMetadataResource.useContext, creating it if it does not already existpublic List<CodeableConcept> getJurisdiction()
getJurisdiction in class MetadataResourceMetadataResource.jurisdiction (A legal or geographic region in which the structure definition is intended to be used.)public StructureDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)
setJurisdiction in class MetadataResourcethis for easy method chainingpublic boolean hasJurisdiction()
hasJurisdiction in class MetadataResourcepublic CodeableConcept addJurisdiction()
addJurisdiction in class MetadataResourcepublic StructureDefinition addJurisdiction(CodeableConcept t)
addJurisdiction in class MetadataResourcepublic CodeableConcept getJurisdictionFirstRep()
getJurisdictionFirstRep in class MetadataResourceMetadataResource.jurisdiction, creating it if it does not already existpublic MarkdownType getPurposeElement()
purpose (Explanation 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 valuepublic boolean hasPurposeElement()
public boolean hasPurpose()
public StructureDefinition setPurposeElement(MarkdownType value)
value - purpose (Explanation 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 valuepublic String getPurpose()
public StructureDefinition setPurpose(String value)
value - Explanation of why this structure definition is needed and why it has been designed as it has.public MarkdownType getCopyrightElement()
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 valuepublic boolean hasCopyrightElement()
public boolean hasCopyright()
public StructureDefinition setCopyrightElement(MarkdownType value)
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 valuepublic String getCopyright()
public StructureDefinition setCopyright(String value)
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.public List<Coding> getKeyword()
keyword (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.)public StructureDefinition setKeyword(List<Coding> theKeyword)
this for easy method chainingpublic boolean hasKeyword()
public Coding addKeyword()
public StructureDefinition addKeyword(Coding t)
public Coding getKeywordFirstRep()
keyword, creating it if it does not already existpublic Enumeration<Enumerations.FHIRVersion> getFhirVersionElement()
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 4.0.1. for this version.). This is the underlying object with id, value and extensions. The accessor "getFhirVersion" gives direct access to the valuepublic boolean hasFhirVersionElement()
public boolean hasFhirVersion()
public StructureDefinition setFhirVersionElement(Enumeration<Enumerations.FHIRVersion> value)
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 4.0.1. for this version.). This is the underlying object with id, value and extensions. The accessor "getFhirVersion" gives direct access to the valuepublic Enumerations.FHIRVersion getFhirVersion()
public StructureDefinition setFhirVersion(Enumerations.FHIRVersion value)
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 4.0.1. for this version.public List<StructureDefinition.StructureDefinitionMappingComponent> getMapping()
mapping (An external specification that the content is mapped to.)public StructureDefinition setMapping(List<StructureDefinition.StructureDefinitionMappingComponent> theMapping)
this for easy method chainingpublic boolean hasMapping()
public StructureDefinition.StructureDefinitionMappingComponent addMapping()
public StructureDefinition addMapping(StructureDefinition.StructureDefinitionMappingComponent t)
public StructureDefinition.StructureDefinitionMappingComponent getMappingFirstRep()
mapping, creating it if it does not already existpublic Enumeration<StructureDefinition.StructureDefinitionKind> getKindElement()
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 valuepublic boolean hasKindElement()
public boolean hasKind()
public StructureDefinition setKindElement(Enumeration<StructureDefinition.StructureDefinitionKind> value)
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 valuepublic StructureDefinition.StructureDefinitionKind getKind()
public StructureDefinition setKind(StructureDefinition.StructureDefinitionKind value)
value - Defines the kind of structure that this definition is describing.public BooleanType getAbstractElement()
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 valuepublic boolean hasAbstractElement()
public boolean hasAbstract()
public StructureDefinition setAbstractElement(BooleanType value)
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 valuepublic boolean getAbstract()
public StructureDefinition setAbstract(boolean value)
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.public List<StructureDefinition.StructureDefinitionContextComponent> getContext()
context (Identifies the types of resource or data type elements to which the extension can be applied.)public StructureDefinition setContext(List<StructureDefinition.StructureDefinitionContextComponent> theContext)
this for easy method chainingpublic boolean hasContext()
public StructureDefinition.StructureDefinitionContextComponent addContext()
public StructureDefinition addContext(StructureDefinition.StructureDefinitionContextComponent t)
public StructureDefinition.StructureDefinitionContextComponent getContextFirstRep()
context, creating it if it does not already existpublic List<StringType> getContextInvariant()
contextInvariant (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.)public StructureDefinition setContextInvariant(List<StringType> theContextInvariant)
this for easy method chainingpublic boolean hasContextInvariant()
public StringType addContextInvariantElement()
contextInvariant (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.)public StructureDefinition addContextInvariant(String value)
value - contextInvariant (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.)public boolean hasContextInvariant(String value)
value - contextInvariant (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.)public UriType getTypeElement()
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). 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.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the valuepublic boolean hasTypeElement()
public boolean hasType()
public StructureDefinition setTypeElement(UriType value)
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). 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.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the valuepublic String getType()
public StructureDefinition setType(String value)
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). 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.public CanonicalType getBaseDefinitionElement()
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 valuepublic boolean hasBaseDefinitionElement()
public boolean hasBaseDefinition()
public StructureDefinition setBaseDefinitionElement(CanonicalType value)
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 valuepublic String getBaseDefinition()
public StructureDefinition setBaseDefinition(String value)
value - An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.public Enumeration<StructureDefinition.TypeDerivationRule> getDerivationElement()
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 valuepublic boolean hasDerivationElement()
public boolean hasDerivation()
public StructureDefinition setDerivationElement(Enumeration<StructureDefinition.TypeDerivationRule> value)
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 valuepublic StructureDefinition.TypeDerivationRule getDerivation()
public StructureDefinition setDerivation(StructureDefinition.TypeDerivationRule value)
value - How the type relates to the baseDefinition.public StructureDefinition.StructureDefinitionSnapshotComponent getSnapshot()
snapshot (A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.)public boolean hasSnapshot()
public StructureDefinition setSnapshot(StructureDefinition.StructureDefinitionSnapshotComponent value)
value - snapshot (A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.)public StructureDefinition.StructureDefinitionDifferentialComponent getDifferential()
differential (A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.)public boolean hasDifferential()
public StructureDefinition setDifferential(StructureDefinition.StructureDefinitionDifferentialComponent value)
value - differential (A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.)protected void listChildren(List<Property> children)
listChildren in class MetadataResourcepublic Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
getNamedProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
getTypesForProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in interface org.hl7.fhir.instance.model.api.IBasefhirType in class MetadataResourcepublic StructureDefinition copy()
copy in class MetadataResourcepublic void copyValues(StructureDefinition dst)
protected StructureDefinition typedCopy()
public boolean equalsDeep(Base other_)
equalsDeep in class MetadataResourcepublic boolean equalsShallow(Base other_)
equalsShallow in class MetadataResourcepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class MetadataResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2021 Health Level 7. All rights reserved.