Class StructureDefinition
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.model.MetadataResource
-
- org.hl7.fhir.r4.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 classStructureDefinition.ExtensionContextTypestatic classStructureDefinition.ExtensionContextTypeEnumFactorystatic classStructureDefinition.StructureDefinitionContextComponentstatic classStructureDefinition.StructureDefinitionDifferentialComponentstatic classStructureDefinition.StructureDefinitionKindstatic classStructureDefinition.StructureDefinitionKindEnumFactorystatic classStructureDefinition.StructureDefinitionMappingComponentstatic classStructureDefinition.StructureDefinitionSnapshotComponentstatic classStructureDefinition.TypeDerivationRulestatic classStructureDefinition.TypeDerivationRuleEnumFactory
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.TokenClientParamABSTRACTFluent Client search parameter constant for abstractprotected BooleanTypeabstract_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.ReferenceClientParamBASEFluent Client search parameter constant for basestatic ca.uhn.fhir.rest.gclient.TokenClientParamBASE_PATHFluent Client search parameter constant for base-pathprotected CanonicalTypebaseDefinitionAn absolute URI that is the base structure from which this type is derived, either by specialization or constraint.protected List<StructureDefinition.StructureDefinitionContextComponent>contextIdentifies the types of resource or data type elements to which the extension can be applied.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXTFluent Client search parameter constant for contextstatic ca.uhn.fhir.rest.gclient.QuantityClientParamCONTEXT_QUANTITYFluent Client search parameter constant for context-quantitystatic ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXT_TYPEFluent Client search parameter constant for context-typestatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>CONTEXT_TYPE_QUANTITYFluent Client search parameter constant for context-type-quantitystatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>CONTEXT_TYPE_VALUEFluent Client search parameter constant for context-type-valueprotected List<StringType>contextInvariantA set of rules as FHIRPath Invariants about when the extension can be used (e.g.protected MarkdownTypecopyrightA copyright statement relating to the structure definition and/or its contents.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected Enumeration<StructureDefinition.TypeDerivationRule>derivationHow the type relates to the baseDefinition.static ca.uhn.fhir.rest.gclient.TokenClientParamDERIVATIONFluent Client search parameter constant for derivationstatic ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionprotected StructureDefinition.StructureDefinitionDifferentialComponentdifferentialA differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.static ca.uhn.fhir.rest.gclient.TokenClientParamEXPERIMENTALFluent Client search parameter constant for experimentalstatic ca.uhn.fhir.rest.gclient.TokenClientParamEXT_CONTEXTFluent Client search parameter constant for ext-contextprotected Enumeration<Enumerations.FHIRVersion>fhirVersionThe 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>identifierA 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.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_BASEConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_VALUESETConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.TokenClientParamJURISDICTIONFluent Client search parameter constant for jurisdictionprotected List<Coding>keywordA 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.TokenClientParamKEYWORDFluent Client search parameter constant for keywordprotected Enumeration<StructureDefinition.StructureDefinitionKind>kindDefines the kind of structure that this definition is describing.static ca.uhn.fhir.rest.gclient.TokenClientParamKINDFluent Client search parameter constant for kindprotected List<StructureDefinition.StructureDefinitionMappingComponent>mappingAn external specification that the content is mapped to.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for namestatic ca.uhn.fhir.rest.gclient.TokenClientParamPATHFluent Client search parameter constant for pathstatic ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherprotected MarkdownTypepurposeExplanation of why this structure definition is needed and why it has been designed as it has.protected StructureDefinition.StructureDefinitionSnapshotComponentsnapshotA snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.static StringSP_ABSTRACTSearch parameter: abstractstatic StringSP_BASESearch parameter: basestatic StringSP_BASE_PATHSearch parameter: base-pathstatic StringSP_CONTEXTSearch parameter: contextstatic StringSP_CONTEXT_QUANTITYSearch parameter: context-quantitystatic StringSP_CONTEXT_TYPESearch parameter: context-typestatic StringSP_CONTEXT_TYPE_QUANTITYSearch parameter: context-type-quantitystatic StringSP_CONTEXT_TYPE_VALUESearch parameter: context-type-valuestatic StringSP_DATESearch parameter: datestatic StringSP_DERIVATIONSearch parameter: derivationstatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_EXPERIMENTALSearch parameter: experimentalstatic StringSP_EXT_CONTEXTSearch parameter: ext-contextstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_JURISDICTIONSearch parameter: jurisdictionstatic StringSP_KEYWORDSearch parameter: keywordstatic StringSP_KINDSearch parameter: kindstatic StringSP_NAMESearch parameter: namestatic StringSP_PATHSearch parameter: pathstatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_STATUSSearch parameter: statusstatic StringSP_TITLESearch parameter: titlestatic StringSP_TYPESearch parameter: typestatic StringSP_URLSearch parameter: urlstatic StringSP_VALUESETSearch parameter: valuesetstatic StringSP_VERSIONSearch parameter: versionstatic ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for titleprotected UriTypetypeThe type this structure describes.static ca.uhn.fhir.rest.gclient.UriClientParamTYPEFluent Client search parameter constant for typestatic ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamVALUESETFluent Client search parameter constant for valuesetstatic ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.r4.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version
-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.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_, UriType type)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.MetadataResource
copyValues, present, toString
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, 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, 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
Explanation 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 nby describing the use of this structure definition, or the content it describes.
-
fhirVersion
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. [publication].[major].[minor], which is 4.0.1. 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.
-
context
protected List<StructureDefinition.StructureDefinitionContextComponent> 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 FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.
-
type
protected UriType 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.
-
baseDefinition
protected CanonicalType 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 standalone 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_CONTEXT_TYPE_VALUE
public static final String SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: A use context type and value assigned to the structure definition
Type: composite
Path:
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_VALUE
public static final 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-valueDescription: A use context type and value assigned to the structure definition
Type: composite
Path:
-
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_CONTEXT_TYPE
public static final String SP_CONTEXT_TYPE
Search parameter: context-typeDescription: A type of use context assigned to the structure definition
Type: token
Path: StructureDefinition.useContext.code
- 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: A type of use context assigned to the structure definition
Type: token
Path: StructureDefinition.useContext.code
-
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_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: uri
Path: StructureDefinition.type
- See Also:
- Constant Field Values
-
TYPE
public static final ca.uhn.fhir.rest.gclient.UriClientParam TYPE
Fluent Client search parameter constant for typeDescription: Type defined or constrained by this structure
Type: uri
Path: StructureDefinition.type
-
SP_CONTEXT_QUANTITY
public static final String SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: A quantity- or range-valued use context assigned to the structure definition
Type: quantity
Path: StructureDefinition.useContext.valueQuantity, StructureDefinition.useContext.valueRange
- See Also:
- Constant Field Values
-
CONTEXT_QUANTITY
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: A quantity- or range-valued use context assigned to the structure definition
Type: quantity
Path: StructureDefinition.useContext.valueQuantity, StructureDefinition.useContext.valueRange
-
SP_PATH
public static final String SP_PATH
Search parameter: pathDescription: A path that is constrained in the StructureDefinition
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 StructureDefinition
Type: token
Path: StructureDefinition.snapshot.element.path, StructureDefinition.differential.element.path
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the structure definition
Type: token
Path: StructureDefinition.useContext.valueCodeableConcept
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the structure definition
Type: token
Path: StructureDefinition.useContext.valueCodeableConcept
-
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_KEYWORD
public static final String SP_KEYWORD
Search parameter: keywordDescription: A code for the StructureDefinition
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 StructureDefinition
Type: token
Path: StructureDefinition.keyword
-
SP_CONTEXT_TYPE_QUANTITY
public static final String SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the structure definition
Type: composite
Path:
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_QUANTITY
public static final 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-quantityDescription: A use context type and quantity- or range-based value assigned to the structure definition
Type: composite
Path:
-
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
- 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
-
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_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_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_EXT_CONTEXT
public static final String SP_EXT_CONTEXT
Search parameter: ext-contextDescription: 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
- See Also:
- Constant Field Values
-
EXT_CONTEXT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam EXT_CONTEXT
Fluent Client search parameter constant for ext-contextDescription: 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
-
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_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_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: reference
Path: StructureDefinition.baseDefinition
- See Also:
- Constant Field Values
-
BASE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASE
Fluent Client search parameter constant for baseDescription: Definition that this type is constrained/specialized from
Type: reference
Path: StructureDefinition.baseDefinition
-
INCLUDE_BASE
public static final ca.uhn.fhir.model.api.Include INCLUDE_BASE
Constant for fluent queries to be used to add include statements. Specifies the path value of "StructureDefinition:base".
-
-
Constructor Detail
-
StructureDefinition
public StructureDefinition()
Constructor
-
StructureDefinition
public StructureDefinition(UriType url, StringType name, Enumeration<Enumerations.PublicationStatus> status, Enumeration<StructureDefinition.StructureDefinitionKind> kind, BooleanType abstract_, UriType type)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Overrides:
getUrlElementin 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; 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 value
-
hasUrlElement
public boolean hasUrlElement()
- Overrides:
hasUrlElementin classMetadataResource
-
hasUrl
public boolean hasUrl()
- Overrides:
hasUrlin classMetadataResource
-
setUrlElement
public StructureDefinition setUrlElement(UriType value)
- Overrides:
setUrlElementin 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; 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 value
-
getUrl
public String getUrl()
- Overrides:
getUrlin 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; 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.
-
setUrl
public StructureDefinition setUrl(String value)
- Overrides:
setUrlin 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; 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.
-
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
thisfor 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:
getVersionElementin 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:
hasVersionElementin classMetadataResource
-
hasVersion
public boolean hasVersion()
- Overrides:
hasVersionin classMetadataResource
-
setVersionElement
public StructureDefinition setVersionElement(StringType value)
- Overrides:
setVersionElementin 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:
getVersionin 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:
setVersionin 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:
getNameElementin 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:
hasNameElementin classMetadataResource
-
hasName
public boolean hasName()
- Overrides:
hasNamein classMetadataResource
-
setNameElement
public StructureDefinition setNameElement(StringType value)
- Overrides:
setNameElementin 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:
getNamein 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:
setNamein 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:
getTitleElementin 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:
hasTitleElementin classMetadataResource
-
hasTitle
public boolean hasTitle()
- Overrides:
hasTitlein classMetadataResource
-
setTitleElement
public StructureDefinition setTitleElement(StringType value)
- Overrides:
setTitleElementin 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:
getTitlein classMetadataResource- Returns:
- A short, descriptive, user-friendly title for the structure definition.
-
setTitle
public StructureDefinition setTitle(String value)
- Overrides:
setTitlein classMetadataResource- Parameters:
value- A short, descriptive, user-friendly title for the structure definition.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Overrides:
getStatusElementin 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:
hasStatusElementin classMetadataResource
-
hasStatus
public boolean hasStatus()
- Overrides:
hasStatusin classMetadataResource
-
setStatusElement
public StructureDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Overrides:
setStatusElementin 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:
getStatusin classMetadataResource- Returns:
- The status of this structure definition. Enables tracking the life-cycle of the content.
-
setStatus
public StructureDefinition setStatus(Enumerations.PublicationStatus value)
- Overrides:
setStatusin classMetadataResource- Parameters:
value- The status of this structure definition. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Overrides:
getExperimentalElementin 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:
hasExperimentalElementin classMetadataResource
-
hasExperimental
public boolean hasExperimental()
- Overrides:
hasExperimentalin classMetadataResource
-
setExperimentalElement
public StructureDefinition setExperimentalElement(BooleanType value)
- Overrides:
setExperimentalElementin 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:
getExperimentalin 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:
setExperimentalin 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:
getDateElementin classMetadataResource- Returns:
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 value
-
hasDateElement
public boolean hasDateElement()
- Overrides:
hasDateElementin classMetadataResource
-
hasDate
public boolean hasDate()
- Overrides:
hasDatein classMetadataResource
-
setDateElement
public StructureDefinition setDateElement(DateTimeType value)
- Overrides:
setDateElementin classMetadataResource- Parameters:
value-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 value
-
getDate
public Date getDate()
- Overrides:
getDatein classMetadataResource- Returns:
- 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.
-
setDate
public StructureDefinition setDate(Date value)
- Overrides:
setDatein classMetadataResource- Parameters:
value- 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.
-
getPublisherElement
public StringType getPublisherElement()
- Overrides:
getPublisherElementin classMetadataResource- Returns:
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 value
-
hasPublisherElement
public boolean hasPublisherElement()
- Overrides:
hasPublisherElementin classMetadataResource
-
hasPublisher
public boolean hasPublisher()
- Overrides:
hasPublisherin classMetadataResource
-
setPublisherElement
public StructureDefinition setPublisherElement(StringType value)
- Overrides:
setPublisherElementin classMetadataResource- Parameters:
value-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 value
-
getPublisher
public String getPublisher()
- Overrides:
getPublisherin classMetadataResource- Returns:
- The name of the organization or individual that published the structure definition.
-
setPublisher
public StructureDefinition setPublisher(String value)
- Overrides:
setPublisherin classMetadataResource- Parameters:
value- The name of the organization or individual that published the structure definition.
-
getContact
public List<ContactDetail> getContact()
- Overrides:
getContactin 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:
setContactin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
- Overrides:
hasContactin classMetadataResource
-
addContact
public ContactDetail addContact()
- Overrides:
addContactin classMetadataResource
-
addContact
public StructureDefinition addContact(ContactDetail t)
- Overrides:
addContactin classMetadataResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Overrides:
getContactFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.contact, creating it if it does not already exist
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Overrides:
getDescriptionElementin 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:
hasDescriptionElementin classMetadataResource
-
hasDescription
public boolean hasDescription()
- Overrides:
hasDescriptionin classMetadataResource
-
setDescriptionElement
public StructureDefinition setDescriptionElement(MarkdownType value)
- Overrides:
setDescriptionElementin 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:
getDescriptionin classMetadataResource- Returns:
- A free text natural language description of the structure definition from a consumer's perspective.
-
setDescription
public StructureDefinition setDescription(String value)
- Overrides:
setDescriptionin classMetadataResource- Parameters:
value- A free text natural language description of the structure definition from a consumer's perspective.
-
getUseContext
public List<UsageContext> getUseContext()
- Overrides:
getUseContextin classMetadataResource- Returns:
MetadataResource.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.)
-
setUseContext
public StructureDefinition setUseContext(List<UsageContext> theUseContext)
- Overrides:
setUseContextin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Overrides:
hasUseContextin classMetadataResource
-
addUseContext
public UsageContext addUseContext()
- Overrides:
addUseContextin classMetadataResource
-
addUseContext
public StructureDefinition addUseContext(UsageContext t)
- Overrides:
addUseContextin classMetadataResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Overrides:
getUseContextFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.useContext, creating it if it does not already exist
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Overrides:
getJurisdictionin 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:
setJurisdictionin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Overrides:
hasJurisdictionin classMetadataResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Overrides:
addJurisdictionin classMetadataResource
-
addJurisdiction
public StructureDefinition addJurisdiction(CodeableConcept t)
- Overrides:
addJurisdictionin classMetadataResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Overrides:
getJurisdictionFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction, creating it if it does not already exist
-
getPurposeElement
public MarkdownType getPurposeElement()
- Returns:
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 value
-
hasPurposeElement
public boolean hasPurposeElement()
-
hasPurpose
public boolean hasPurpose()
-
setPurposeElement
public StructureDefinition setPurposeElement(MarkdownType value)
- Parameters:
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 value
-
getPurpose
public String getPurpose()
- Returns:
- Explanation of why this structure definition is needed and why it has been designed as it has.
-
setPurpose
public StructureDefinition setPurpose(String value)
- Parameters:
value- Explanation 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 nby describing the use of this structure definition, or the content it describes.)
-
setKeyword
public StructureDefinition setKeyword(List<Coding> theKeyword)
- Returns:
- Returns a reference to
thisfor 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 Enumeration<Enumerations.FHIRVersion> 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 4.0.1. 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(Enumeration<Enumerations.FHIRVersion> 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 4.0.1. for this version.). This is the underlying object with id, value and extensions. The accessor "getFhirVersion" gives direct access to the value
-
getFhirVersion
public Enumerations.FHIRVersion 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 4.0.1. for this version.
-
setFhirVersion
public StructureDefinition setFhirVersion(Enumerations.FHIRVersion 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 4.0.1. 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
thisfor 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.
-
getContext
public List<StructureDefinition.StructureDefinitionContextComponent> getContext()
- Returns:
context(Identifies the types of resource or data type elements to which the extension can be applied.)
-
setContext
public StructureDefinition setContext(List<StructureDefinition.StructureDefinitionContextComponent> theContext)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContext
public boolean hasContext()
-
addContext
public StructureDefinition.StructureDefinitionContextComponent addContext()
-
addContext
public StructureDefinition addContext(StructureDefinition.StructureDefinitionContextComponent t)
-
getContextFirstRep
public StructureDefinition.StructureDefinitionContextComponent getContextFirstRep()
- Returns:
- The first repetition of repeating field
context, creating it if it does not already exist
-
getContextInvariant
public List<StringType> getContextInvariant()
- Returns:
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.)
-
setContextInvariant
public StructureDefinition setContextInvariant(List<StringType> theContextInvariant)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContextInvariant
public boolean hasContextInvariant()
-
addContextInvariantElement
public StringType addContextInvariantElement()
- Returns:
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.)
-
addContextInvariant
public StructureDefinition addContextInvariant(String value)
- Parameters:
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.)
-
hasContextInvariant
public boolean hasContextInvariant(String value)
- Parameters:
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.)
-
getTypeElement
public UriType 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). 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 value
-
hasTypeElement
public boolean hasTypeElement()
-
hasType
public boolean hasType()
-
setTypeElement
public StructureDefinition setTypeElement(UriType 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). 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 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). 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.
-
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). 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.
-
getBaseDefinitionElement
public CanonicalType 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(CanonicalType 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 standalone 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 standalone 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:
listChildrenin classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classMetadataResource
-
copy
public StructureDefinition copy()
- Specified by:
copyin classMetadataResource
-
copyValues
public void copyValues(StructureDefinition dst)
-
typedCopy
protected StructureDefinition typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classMetadataResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classMetadataResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classMetadataResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-