Package org.hl7.fhir.r4.model

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 enum	StructureDefinition.ExtensionContextType
static class	StructureDefinition.ExtensionContextTypeEnumFactory
static class	StructureDefinition.StructureDefinitionContextComponent
static class	StructureDefinition.StructureDefinitionDifferentialComponent
static enum	StructureDefinition.StructureDefinitionKind
static class	StructureDefinition.StructureDefinitionKindEnumFactory
static class	StructureDefinition.StructureDefinitionMappingComponent
static class	StructureDefinition.StructureDefinitionSnapshotComponent
static enum	StructureDefinition.TypeDerivationRule
static class	StructureDefinition.TypeDerivationRuleEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final 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 final ca.uhn.fhir.rest.gclient.ReferenceClientParam	BASE	Fluent Client search parameter constant for base
static final 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 final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTEXT	Fluent Client search parameter constant for context
static final ca.uhn.fhir.rest.gclient.QuantityClientParam	CONTEXT_QUANTITY	Fluent Client search parameter constant for context-quantity
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTEXT_TYPE	Fluent Client search parameter constant for context-type
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-quantity
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-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 final 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 final ca.uhn.fhir.rest.gclient.TokenClientParam	DERIVATION	Fluent Client search parameter constant for derivation
static final 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 final ca.uhn.fhir.rest.gclient.TokenClientParam	EXPERIMENTAL	Fluent Client search parameter constant for experimental
static final 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 final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_BASE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_VALUESET	Constant for fluent queries to be used to add include statements.
static final 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 final 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 final 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 final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PATH	Fluent Client search parameter constant for path
static final 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 final String	SP_ABSTRACT	Search parameter: abstract
static final String	SP_BASE	Search parameter: base
static final String	SP_BASE_PATH	Search parameter: base-path
static final String	SP_CONTEXT	Search parameter: context
static final String	SP_CONTEXT_QUANTITY	Search parameter: context-quantity
static final String	SP_CONTEXT_TYPE	Search parameter: context-type
static final String	SP_CONTEXT_TYPE_QUANTITY	Search parameter: context-type-quantity
static final String	SP_CONTEXT_TYPE_VALUE	Search parameter: context-type-value
static final String	SP_DATE	Search parameter: date
static final String	SP_DERIVATION	Search parameter: derivation
static final String	SP_DESCRIPTION	Search parameter: description
static final String	SP_EXPERIMENTAL	Search parameter: experimental
static final String	SP_EXT_CONTEXT	Search parameter: ext-context
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_JURISDICTION	Search parameter: jurisdiction
static final String	SP_KEYWORD	Search parameter: keyword
static final String	SP_KIND	Search parameter: kind
static final String	SP_NAME	Search parameter: name
static final String	SP_PATH	Search parameter: path
static final String	SP_PUBLISHER	Search parameter: publisher
static final String	SP_STATUS	Search parameter: status
static final String	SP_TITLE	Search parameter: title
static final String	SP_TYPE	Search parameter: type
static final String	SP_URL	Search parameter: url
static final String	SP_VALUESET	Search parameter: valueset
static final String	SP_VERSION	Search parameter: version
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
static final ca.uhn.fhir.rest.gclient.StringClientParam	TITLE	Fluent Client search parameter constant for title
protected UriType	type	The type this structure describes.
static final ca.uhn.fhir.rest.gclient.UriClientParam	TYPE	Fluent Client search parameter constant for type
static final ca.uhn.fhir.rest.gclient.UriClientParam	URL	Fluent Client search parameter constant for url
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	VALUESET	Fluent Client search parameter constant for valueset
static final ca.uhn.fhir.rest.gclient.TokenClientParam	VERSION	Fluent 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

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
StructureDefinition()	Constructor
StructureDefinition(UriType url, StringType name, Enumeration<Enumerations.PublicationStatus> status, Enumeration<StructureDefinition.StructureDefinitionKind> kind, BooleanType abstract_, UriType type)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
ContactDetail	addContact()
StructureDefinition	addContact(ContactDetail t)
StructureDefinition.StructureDefinitionContextComponent	addContext()
StructureDefinition	addContext(StructureDefinition.StructureDefinitionContextComponent t)
StructureDefinition	addContextInvariant(String value)
StringType	addContextInvariantElement()
Identifier	addIdentifier()
StructureDefinition	addIdentifier(Identifier t)
CodeableConcept	addJurisdiction()
StructureDefinition	addJurisdiction(CodeableConcept t)
Coding	addKeyword()
StructureDefinition	addKeyword(Coding t)
StructureDefinition.StructureDefinitionMappingComponent	addMapping()
StructureDefinition	addMapping(StructureDefinition.StructureDefinitionMappingComponent t)
UsageContext	addUseContext()
StructureDefinition	addUseContext(UsageContext t)
StructureDefinition	copy()
void	copyValues(StructureDefinition dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getAbstract()
BooleanType	getAbstractElement()
String	getBaseDefinition()
CanonicalType	getBaseDefinitionElement()
List<ContactDetail>	getContact()
ContactDetail	getContactFirstRep()
List<StructureDefinition.StructureDefinitionContextComponent>	getContext()
StructureDefinition.StructureDefinitionContextComponent	getContextFirstRep()
List<StringType>	getContextInvariant()
String	getCopyright()
MarkdownType	getCopyrightElement()
Date	getDate()
DateTimeType	getDateElement()
StructureDefinition.TypeDerivationRule	getDerivation()
Enumeration<StructureDefinition.TypeDerivationRule>	getDerivationElement()
String	getDescription()
MarkdownType	getDescriptionElement()
StructureDefinition.StructureDefinitionDifferentialComponent	getDifferential()
boolean	getExperimental()
BooleanType	getExperimentalElement()
Enumerations.FHIRVersion	getFhirVersion()
Enumeration<Enumerations.FHIRVersion>	getFhirVersionElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CodeableConcept>	getJurisdiction()
CodeableConcept	getJurisdictionFirstRep()
List<Coding>	getKeyword()
Coding	getKeywordFirstRep()
StructureDefinition.StructureDefinitionKind	getKind()
Enumeration<StructureDefinition.StructureDefinitionKind>	getKindElement()
List<StructureDefinition.StructureDefinitionMappingComponent>	getMapping()
StructureDefinition.StructureDefinitionMappingComponent	getMappingFirstRep()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getPublisher()
StringType	getPublisherElement()
String	getPurpose()
MarkdownType	getPurposeElement()
ResourceType	getResourceType()
StructureDefinition.StructureDefinitionSnapshotComponent	getSnapshot()
Enumerations.PublicationStatus	getStatus()
Enumeration<Enumerations.PublicationStatus>	getStatusElement()
String	getTitle()
StringType	getTitleElement()
String	getType()
UriType	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
String	getUrl()
UriType	getUrlElement()
List<UsageContext>	getUseContext()
UsageContext	getUseContextFirstRep()
String	getVersion()
String	getVersionedUrl()
StringType	getVersionElement()
boolean	hasAbstract()
boolean	hasAbstractElement()
boolean	hasBaseDefinition()
boolean	hasBaseDefinitionElement()
boolean	hasContact()
boolean	hasContext()
boolean	hasContextInvariant()
boolean	hasContextInvariant(String value)
boolean	hasCopyright()
boolean	hasCopyrightElement()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDerivation()
boolean	hasDerivationElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasDifferential()
boolean	hasExperimental()
boolean	hasExperimentalElement()
boolean	hasFhirVersion()
boolean	hasFhirVersionElement()
boolean	hasIdentifier()
boolean	hasJurisdiction()
boolean	hasKeyword()
boolean	hasKind()
boolean	hasKindElement()
boolean	hasMapping()
boolean	hasName()
boolean	hasNameElement()
boolean	hasPublisher()
boolean	hasPublisherElement()
boolean	hasPurpose()
boolean	hasPurposeElement()
boolean	hasSnapshot()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasTitle()
boolean	hasTitleElement()
boolean	hasType()
boolean	hasTypeElement()
boolean	hasUrl()
boolean	hasUrlElement()
boolean	hasUseContext()
boolean	hasVersion()
boolean	hasVersionElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
StructureDefinition	setAbstract(boolean value)
StructureDefinition	setAbstractElement(BooleanType value)
StructureDefinition	setBaseDefinition(String value)
StructureDefinition	setBaseDefinitionElement(CanonicalType value)
StructureDefinition	setContact(List<ContactDetail> theContact)
StructureDefinition	setContext(List<StructureDefinition.StructureDefinitionContextComponent> theContext)
StructureDefinition	setContextInvariant(List<StringType> theContextInvariant)
StructureDefinition	setCopyright(String value)
StructureDefinition	setCopyrightElement(MarkdownType value)
StructureDefinition	setDate(Date value)
StructureDefinition	setDateElement(DateTimeType value)
StructureDefinition	setDerivation(StructureDefinition.TypeDerivationRule value)
StructureDefinition	setDerivationElement(Enumeration<StructureDefinition.TypeDerivationRule> value)
StructureDefinition	setDescription(String value)
StructureDefinition	setDescriptionElement(MarkdownType value)
StructureDefinition	setDifferential(StructureDefinition.StructureDefinitionDifferentialComponent value)
StructureDefinition	setExperimental(boolean value)
StructureDefinition	setExperimentalElement(BooleanType value)
StructureDefinition	setFhirVersion(Enumerations.FHIRVersion value)
StructureDefinition	setFhirVersionElement(Enumeration<Enumerations.FHIRVersion> value)
StructureDefinition	setIdentifier(List<Identifier> theIdentifier)
StructureDefinition	setJurisdiction(List<CodeableConcept> theJurisdiction)
StructureDefinition	setKeyword(List<Coding> theKeyword)
StructureDefinition	setKind(StructureDefinition.StructureDefinitionKind value)
StructureDefinition	setKindElement(Enumeration<StructureDefinition.StructureDefinitionKind> value)
StructureDefinition	setMapping(List<StructureDefinition.StructureDefinitionMappingComponent> theMapping)
StructureDefinition	setName(String value)
StructureDefinition	setNameElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
StructureDefinition	setPublisher(String value)
StructureDefinition	setPublisherElement(StringType value)
StructureDefinition	setPurpose(String value)
StructureDefinition	setPurposeElement(MarkdownType value)
StructureDefinition	setSnapshot(StructureDefinition.StructureDefinitionSnapshotComponent value)
StructureDefinition	setStatus(Enumerations.PublicationStatus value)
StructureDefinition	setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
StructureDefinition	setTitle(String value)
StructureDefinition	setTitleElement(StringType value)
StructureDefinition	setType(String value)
StructureDefinition	setTypeElement(UriType value)
StructureDefinition	setUrl(String value)
StructureDefinition	setUrlElement(UriType value)
StructureDefinition	setUseContext(List<UsageContext> theUseContext)
StructureDefinition	setVersion(String value)
StructureDefinition	setVersionElement(StringType value)
protected StructureDefinition	typedCopy()

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, 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, getIdPart, 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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, 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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

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: date

Description: 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 date

Description: 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-value

Description: 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-value

Description: A use context type and value assigned to the structure definition
Type: composite
Path:

SP_JURISDICTION

public static final String SP_JURISDICTION

Search parameter: jurisdiction

Description: 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 jurisdiction

Description: Intended jurisdiction for the structure definition
Type: token
Path: StructureDefinition.jurisdiction

SP_DESCRIPTION

public static final String SP_DESCRIPTION

Search parameter: description

Description: 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 description

Description: The description of the structure definition
Type: string
Path: StructureDefinition.description

SP_CONTEXT_TYPE

public static final String SP_CONTEXT_TYPE

Search parameter: context-type

Description: 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-type

Description: 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: experimental

Description: 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 experimental

Description: For testing purposes, not real usage
Type: token
Path: StructureDefinition.experimental

SP_TITLE

public static final String SP_TITLE

Search parameter: title

Description: 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 title

Description: The human-friendly name of the structure definition
Type: string
Path: StructureDefinition.title

SP_TYPE

public static final String SP_TYPE

Search parameter: type

Description: 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 type

Description: 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-quantity

Description: 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-quantity

Description: 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: path

Description: 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 path

Description: 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: context

Description: 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 context

Description: 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-path

Description: 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-path

Description: 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: keyword

Description: 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 keyword

Description: 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-quantity

Description: 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-quantity

Description: 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: identifier

Description: 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 identifier

Description: External identifier for the structure definition
Type: token
Path: StructureDefinition.identifier

SP_VALUESET

public static final String SP_VALUESET

Search parameter: valueset

Description: 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 valueset

Description: 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: kind

Description: 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 kind

Description: primitive-type | complex-type | resource | logical
Type: token
Path: StructureDefinition.kind

SP_ABSTRACT

public static final String SP_ABSTRACT

Search parameter: abstract

Description: 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 abstract

Description: Whether the structure is abstract
Type: token
Path: StructureDefinition.abstract

SP_VERSION

public static final String SP_VERSION

Search parameter: version

Description: 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 version

Description: The business version of the structure definition
Type: token
Path: StructureDefinition.version

SP_URL

public static final String SP_URL

Search parameter: url

Description: 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 url

Description: 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-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

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-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

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: 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 name

Description: Computationally friendly name of the structure definition
Type: string
Path: StructureDefinition.name

SP_PUBLISHER

public static final String SP_PUBLISHER

Search parameter: publisher

Description: 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 publisher

Description: Name of the publisher of the structure definition
Type: string
Path: StructureDefinition.publisher

SP_DERIVATION

public static final String SP_DERIVATION

Search parameter: derivation

Description: 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 derivation

Description: specialization | constraint - How relates to base definition
Type: token
Path: StructureDefinition.derivation

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: 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 status

Description: The current status of the structure definition
Type: token
Path: StructureDefinition.status

SP_BASE

public static final String SP_BASE

Search parameter: base

Description: 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 base

Description: 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 Details

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 Details

getUrlElement

public UriType getUrlElement()

Overrides:

getUrlElement in class MetadataResource

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:

hasUrlElement in class MetadataResource

hasUrl

public boolean hasUrl()

Overrides:

hasUrl in class MetadataResource

setUrlElement

public StructureDefinition setUrlElement(UriType value)

Overrides:

setUrlElement in class MetadataResource

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:

getUrl in class MetadataResource

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:

setUrl in class MetadataResource

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 this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public StructureDefinition addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getVersionElement

public StringType getVersionElement()

Overrides:

getVersionElement in class MetadataResource

Returns:

MetadataResource.version (The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

hasVersionElement

public boolean hasVersionElement()

Overrides:

hasVersionElement in class MetadataResource

hasVersion

public boolean hasVersion()

Overrides:

hasVersion in class MetadataResource

setVersionElement

public StructureDefinition setVersionElement(StringType value)

Overrides:

setVersionElement in class MetadataResource

Parameters:

value - MetadataResource.version (The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

getVersion

public String getVersion()

Overrides:

getVersion in class MetadataResource

Returns:

The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

setVersion

public StructureDefinition setVersion(String value)

Overrides:

setVersion in class MetadataResource

Parameters:

value - The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

getNameElement

public StringType getNameElement()

Overrides:

getNameElement in class MetadataResource

Returns:

MetadataResource.name (A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

hasNameElement

public boolean hasNameElement()

Overrides:

hasNameElement in class MetadataResource

hasName

public boolean hasName()

Overrides:

hasName in class MetadataResource

setNameElement

public StructureDefinition setNameElement(StringType value)

Overrides:

setNameElement in class MetadataResource

Parameters:

value - MetadataResource.name (A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

getName

public String getName()

Overrides:

getName in class MetadataResource

Returns:

A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

setName

public StructureDefinition setName(String value)

Overrides:

setName in class MetadataResource

Parameters:

value - A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

getTitleElement

public StringType getTitleElement()

Overrides:

getTitleElement in class MetadataResource

Returns:

MetadataResource.title (A short, descriptive, user-friendly title for the structure definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

hasTitleElement

public boolean hasTitleElement()

Overrides:

hasTitleElement in class MetadataResource

hasTitle

public boolean hasTitle()

Overrides:

hasTitle in class MetadataResource

setTitleElement

public StructureDefinition setTitleElement(StringType value)

Overrides:

setTitleElement in class MetadataResource

Parameters:

value - MetadataResource.title (A short, descriptive, user-friendly title for the structure definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

getTitle

public String getTitle()

Overrides:

getTitle in class MetadataResource

Returns:

A short, descriptive, user-friendly title for the structure definition.

setTitle

public StructureDefinition setTitle(String value)

Overrides:

setTitle in class MetadataResource

Parameters:

value - A short, descriptive, user-friendly title for the structure definition.

getStatusElement

public Enumeration<Enumerations.PublicationStatus> getStatusElement()

Overrides:

getStatusElement in class MetadataResource

Returns:

MetadataResource.status (The status of this structure definition. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

Overrides:

hasStatusElement in class MetadataResource

hasStatus

public boolean hasStatus()

Overrides:

hasStatus in class MetadataResource

setStatusElement

public StructureDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)

Overrides:

setStatusElement in class MetadataResource

Parameters:

value - MetadataResource.status (The status of this structure definition. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Enumerations.PublicationStatus getStatus()

Overrides:

getStatus in class MetadataResource

Returns:

The status of this structure definition. Enables tracking the life-cycle of the content.

setStatus

public StructureDefinition setStatus(Enumerations.PublicationStatus value)

Overrides:

setStatus in class MetadataResource

Parameters:

value - The status of this structure definition. Enables tracking the life-cycle of the content.

getExperimentalElement

public BooleanType getExperimentalElement()

Overrides:

getExperimentalElement in class MetadataResource

Returns:

MetadataResource.experimental (A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value

hasExperimentalElement

public boolean hasExperimentalElement()

Overrides:

hasExperimentalElement in class MetadataResource

hasExperimental

public boolean hasExperimental()

Overrides:

hasExperimental in class MetadataResource

setExperimentalElement

public StructureDefinition setExperimentalElement(BooleanType value)

Overrides:

setExperimentalElement in class MetadataResource

Parameters:

value - MetadataResource.experimental (A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value

getExperimental

public boolean getExperimental()

Overrides:

getExperimental in class MetadataResource

Returns:

A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

setExperimental

public StructureDefinition setExperimental(boolean value)

Overrides:

setExperimental in class MetadataResource

Parameters:

value - A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

getDateElement

public DateTimeType getDateElement()

Overrides:

getDateElement in class MetadataResource

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:

hasDateElement in class MetadataResource

hasDate

public boolean hasDate()

Overrides:

hasDate in class MetadataResource

setDateElement

public StructureDefinition setDateElement(DateTimeType value)

Overrides:

setDateElement in class MetadataResource

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:

getDate in class MetadataResource

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:

setDate in class MetadataResource

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:

getPublisherElement in class MetadataResource

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:

hasPublisherElement in class MetadataResource

hasPublisher

public boolean hasPublisher()

Overrides:

hasPublisher in class MetadataResource

setPublisherElement

public StructureDefinition setPublisherElement(StringType value)

Overrides:

setPublisherElement in class MetadataResource

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:

getPublisher in class MetadataResource

Returns:

The name of the organization or individual that published the structure definition.

setPublisher

public StructureDefinition setPublisher(String value)

Overrides:

setPublisher in class MetadataResource

Parameters:

value - The name of the organization or individual that published the structure definition.

getContact

public List<ContactDetail> getContact()

Overrides:

getContact in class MetadataResource

Returns:

MetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)

setContact

public StructureDefinition setContact(List<ContactDetail> theContact)

Overrides:

setContact in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasContact

public boolean hasContact()

Overrides:

hasContact in class MetadataResource

addContact

public ContactDetail addContact()

Overrides:

addContact in class MetadataResource

addContact

public StructureDefinition addContact(ContactDetail t)

Overrides:

addContact in class MetadataResource

getContactFirstRep

public ContactDetail getContactFirstRep()

Overrides:

getContactFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.contact, creating it if it does not already exist

getDescriptionElement

public MarkdownType getDescriptionElement()

Overrides:

getDescriptionElement in class MetadataResource

Returns:

MetadataResource.description (A free text natural language description of the structure definition from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

Overrides:

hasDescriptionElement in class MetadataResource

hasDescription

public boolean hasDescription()

Overrides:

hasDescription in class MetadataResource

setDescriptionElement

public StructureDefinition setDescriptionElement(MarkdownType value)

Overrides:

setDescriptionElement in class MetadataResource

Parameters:

value - MetadataResource.description (A free text natural language description of the structure definition from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Overrides:

getDescription in class MetadataResource

Returns:

A free text natural language description of the structure definition from a consumer's perspective.

setDescription

public StructureDefinition setDescription(String value)

Overrides:

setDescription in class MetadataResource

Parameters:

value - A free text natural language description of the structure definition from a consumer's perspective.

getUseContext

public List<UsageContext> getUseContext()

Overrides:

getUseContext in class MetadataResource

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:

setUseContext in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasUseContext

public boolean hasUseContext()

Overrides:

hasUseContext in class MetadataResource

addUseContext

public UsageContext addUseContext()

Overrides:

addUseContext in class MetadataResource

addUseContext

public StructureDefinition addUseContext(UsageContext t)

Overrides:

addUseContext in class MetadataResource

getUseContextFirstRep

public UsageContext getUseContextFirstRep()

Overrides:

getUseContextFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.useContext, creating it if it does not already exist

getJurisdiction

public List<CodeableConcept> getJurisdiction()

Overrides:

getJurisdiction in class MetadataResource

Returns:

MetadataResource.jurisdiction (A legal or geographic region in which the structure definition is intended to be used.)

setJurisdiction

public StructureDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)

Overrides:

setJurisdiction in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasJurisdiction

public boolean hasJurisdiction()

Overrides:

hasJurisdiction in class MetadataResource

addJurisdiction

public CodeableConcept addJurisdiction()

Overrides:

addJurisdiction in class MetadataResource

addJurisdiction

public StructureDefinition addJurisdiction(CodeableConcept t)

Overrides:

addJurisdiction in class MetadataResource

getJurisdictionFirstRep

public CodeableConcept getJurisdictionFirstRep()

Overrides:

getJurisdictionFirstRep in class MetadataResource

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 this for easy method chaining

hasKeyword

public boolean hasKeyword()

addKeyword

public Coding addKeyword()

addKeyword

public StructureDefinition addKeyword(Coding t)

getKeywordFirstRep

public Coding getKeywordFirstRep()

Returns:

The first repetition of repeating field keyword, creating it if it does not already exist

getFhirVersionElement

public 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 this for easy method chaining

hasMapping

public boolean hasMapping()

addMapping

public StructureDefinition.StructureDefinitionMappingComponent addMapping()

addMapping

public StructureDefinition addMapping(StructureDefinition.StructureDefinitionMappingComponent t)

getMappingFirstRep

public StructureDefinition.StructureDefinitionMappingComponent getMappingFirstRep()

Returns:

The first repetition of repeating field mapping, creating it if it does not already exist

getKindElement

public Enumeration<StructureDefinition.StructureDefinitionKind> getKindElement()

Returns:

kind (Defines the kind of structure that this definition is describing.). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value

hasKindElement

public boolean hasKindElement()

hasKind

public boolean hasKind()

setKindElement

public StructureDefinition setKindElement(Enumeration<StructureDefinition.StructureDefinitionKind> value)

Parameters:

value - kind (Defines the kind of structure that this definition is describing.). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value

getKind

public StructureDefinition.StructureDefinitionKind getKind()

Returns:

Defines the kind of structure that this definition is describing.

setKind

public StructureDefinition setKind(StructureDefinition.StructureDefinitionKind value)

Parameters:

value - Defines the kind of structure that this definition is describing.

getAbstractElement

public BooleanType getAbstractElement()

Returns:

abstract_ (Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.). This is the underlying object with id, value and extensions. The accessor "getAbstract" gives direct access to the value

hasAbstractElement

public boolean hasAbstractElement()

hasAbstract

public boolean hasAbstract()

setAbstractElement

public StructureDefinition setAbstractElement(BooleanType value)

Parameters:

value - abstract_ (Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.). This is the underlying object with id, value and extensions. The accessor "getAbstract" gives direct access to the value

getAbstract

public boolean getAbstract()

Returns:

Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.

setAbstract

public StructureDefinition setAbstract(boolean value)

Parameters:

value - Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.

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 this for 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 this for 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:

listChildren in class MetadataResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class MetadataResource

copy

public StructureDefinition copy()

Specified by:

copy in class MetadataResource

copyValues

public void copyValues(StructureDefinition dst)

typedCopy

protected StructureDefinition typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class MetadataResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class MetadataResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class MetadataResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource

getVersionedUrl

public String getVersionedUrl()