Package org.hl7.fhir.r4.model

Class CapabilityStatement

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

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.IBaseConformance, 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 CapabilityStatement
extends MetadataResource
implements org.hl7.fhir.instance.model.api.IBaseConformance

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CapabilityStatement.CapabilityStatementDocumentComponent
static class	CapabilityStatement.CapabilityStatementImplementationComponent
static enum	CapabilityStatement.CapabilityStatementKind
static class	CapabilityStatement.CapabilityStatementKindEnumFactory
static class	CapabilityStatement.CapabilityStatementMessagingComponent
static class	CapabilityStatement.CapabilityStatementMessagingEndpointComponent
static class	CapabilityStatement.CapabilityStatementMessagingSupportedMessageComponent
static class	CapabilityStatement.CapabilityStatementRestComponent
static class	CapabilityStatement.CapabilityStatementRestResourceComponent
static class	CapabilityStatement.CapabilityStatementRestResourceOperationComponent
static class	CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent
static class	CapabilityStatement.CapabilityStatementRestSecurityComponent
static class	CapabilityStatement.CapabilityStatementSoftwareComponent
static enum	CapabilityStatement.ConditionalDeleteStatus
static class	CapabilityStatement.ConditionalDeleteStatusEnumFactory
static enum	CapabilityStatement.ConditionalReadStatus
static class	CapabilityStatement.ConditionalReadStatusEnumFactory
static enum	CapabilityStatement.DocumentMode
static class	CapabilityStatement.DocumentModeEnumFactory
static enum	CapabilityStatement.EventCapabilityMode
static class	CapabilityStatement.EventCapabilityModeEnumFactory
static enum	CapabilityStatement.ReferenceHandlingPolicy
static class	CapabilityStatement.ReferenceHandlingPolicyEnumFactory
static class	CapabilityStatement.ResourceInteractionComponent
static enum	CapabilityStatement.ResourceVersionPolicy
static class	CapabilityStatement.ResourceVersionPolicyEnumFactory
static enum	CapabilityStatement.RestfulCapabilityMode
static class	CapabilityStatement.RestfulCapabilityModeEnumFactory
static class	CapabilityStatement.SystemInteractionComponent
static enum	CapabilityStatement.SystemRestfulInteraction
static class	CapabilityStatement.SystemRestfulInteractionEnumFactory
static enum	CapabilityStatement.TypeRestfulInteraction
static class	CapabilityStatement.TypeRestfulInteractionEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
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 MarkdownType	copyright	A copyright statement relating to the capability statement and/or its contents.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
static final ca.uhn.fhir.rest.gclient.StringClientParam	DESCRIPTION	Fluent Client search parameter constant for description
protected List<CapabilityStatement.CapabilityStatementDocumentComponent>	document	A document definition.
protected Enumeration<Enumerations.FHIRVersion>	fhirVersion	The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	FHIRVERSION	Fluent Client search parameter constant for fhirversion
protected List<CodeType>	format	A list of the formats supported by this implementation using their content types.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	FORMAT	Fluent Client search parameter constant for format
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	GUIDE	Fluent Client search parameter constant for guide
protected CapabilityStatement.CapabilityStatementImplementationComponent	implementation	Identifies a specific implementation instance that is described by the capability statement - i.e.
protected List<CanonicalType>	implementationGuide	A list of implementation guides that the server does (or should) support in their entirety.
protected List<CanonicalType>	imports	Reference to a canonical URL of another CapabilityStatement that this software adds to.
static final ca.uhn.fhir.model.api.Include	INCLUDE_GUIDE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_RESOURCE_PROFILE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUPPORTED_PROFILE	Constant for fluent queries to be used to add include statements.
protected List<CanonicalType>	instantiates	Reference to a canonical URL of another CapabilityStatement that this software implements.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	JURISDICTION	Fluent Client search parameter constant for jurisdiction
protected Enumeration<CapabilityStatement.CapabilityStatementKind>	kind	The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g.
protected List<CapabilityStatement.CapabilityStatementMessagingComponent>	messaging	A description of the messaging capabilities of the solution.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	MODE	Fluent Client search parameter constant for mode
static final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
protected List<CodeType>	patchFormat	A list of the patch formats supported by this implementation using their content types.
static final ca.uhn.fhir.rest.gclient.StringClientParam	PUBLISHER	Fluent Client search parameter constant for publisher
protected MarkdownType	purpose	Explanation of why this capability statement is needed and why it has been designed as it has.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	RESOURCE	Fluent Client search parameter constant for resource
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	RESOURCE_PROFILE	Fluent Client search parameter constant for resource-profile
protected List<CapabilityStatement.CapabilityStatementRestComponent>	rest	A definition of the restful capabilities of the solution, if any.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SECURITY_SERVICE	Fluent Client search parameter constant for security-service
protected CapabilityStatement.CapabilityStatementSoftwareComponent	software	Software that is covered by this capability statement.
static final ca.uhn.fhir.rest.gclient.StringClientParam	SOFTWARE	Fluent Client search parameter constant for software
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_DESCRIPTION	Search parameter: description
static final String	SP_FHIRVERSION	Search parameter: fhirversion
static final String	SP_FORMAT	Search parameter: format
static final String	SP_GUIDE	Search parameter: guide
static final String	SP_JURISDICTION	Search parameter: jurisdiction
static final String	SP_MODE	Search parameter: mode
static final String	SP_NAME	Search parameter: name
static final String	SP_PUBLISHER	Search parameter: publisher
static final String	SP_RESOURCE	Search parameter: resource
static final String	SP_RESOURCE_PROFILE	Search parameter: resource-profile
static final String	SP_SECURITY_SERVICE	Search parameter: security-service
static final String	SP_SOFTWARE	Search parameter: software
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUPPORTED_PROFILE	Search parameter: supported-profile
static final String	SP_TITLE	Search parameter: title
static final String	SP_URL	Search parameter: url
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.ReferenceClientParam	SUPPORTED_PROFILE	Fluent Client search parameter constant for supported-profile
static final ca.uhn.fhir.rest.gclient.StringClientParam	TITLE	Fluent Client search parameter constant for title
static final ca.uhn.fhir.rest.gclient.UriClientParam	URL	Fluent Client search parameter constant for url
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
CapabilityStatement()	Constructor
CapabilityStatement(Enumeration<Enumerations.PublicationStatus> status, DateTimeType date, Enumeration<CapabilityStatement.CapabilityStatementKind> kind, Enumeration<Enumerations.FHIRVersion> fhirVersion)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
ContactDetail	addContact()
CapabilityStatement	addContact(ContactDetail t)
CapabilityStatement.CapabilityStatementDocumentComponent	addDocument()
CapabilityStatement	addDocument(CapabilityStatement.CapabilityStatementDocumentComponent t)
CapabilityStatement	addFormat(String value)
CodeType	addFormatElement()
CapabilityStatement	addImplementationGuide(String value)
CanonicalType	addImplementationGuideElement()
CapabilityStatement	addImports(String value)
CanonicalType	addImportsElement()
CapabilityStatement	addInstantiates(String value)
CanonicalType	addInstantiatesElement()
CodeableConcept	addJurisdiction()
CapabilityStatement	addJurisdiction(CodeableConcept t)
CapabilityStatement.CapabilityStatementMessagingComponent	addMessaging()
CapabilityStatement	addMessaging(CapabilityStatement.CapabilityStatementMessagingComponent t)
CapabilityStatement	addPatchFormat(String value)
CodeType	addPatchFormatElement()
CapabilityStatement.CapabilityStatementRestComponent	addRest()
CapabilityStatement	addRest(CapabilityStatement.CapabilityStatementRestComponent t)
UsageContext	addUseContext()
CapabilityStatement	addUseContext(UsageContext t)
CapabilityStatement	copy()
void	copyValues(CapabilityStatement dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<ContactDetail>	getContact()
ContactDetail	getContactFirstRep()
String	getCopyright()
MarkdownType	getCopyrightElement()
Date	getDate()
DateTimeType	getDateElement()
String	getDescription()
MarkdownType	getDescriptionElement()
List<CapabilityStatement.CapabilityStatementDocumentComponent>	getDocument()
CapabilityStatement.CapabilityStatementDocumentComponent	getDocumentFirstRep()
boolean	getExperimental()
BooleanType	getExperimentalElement()
Enumerations.FHIRVersion	getFhirVersion()
Enumeration<Enumerations.FHIRVersion>	getFhirVersionElement()
List<CodeType>	getFormat()
CapabilityStatement.CapabilityStatementImplementationComponent	getImplementation()
List<CanonicalType>	getImplementationGuide()
List<CanonicalType>	getImports()
List<CanonicalType>	getInstantiates()
List<CodeableConcept>	getJurisdiction()
CodeableConcept	getJurisdictionFirstRep()
CapabilityStatement.CapabilityStatementKind	getKind()
Enumeration<CapabilityStatement.CapabilityStatementKind>	getKindElement()
List<CapabilityStatement.CapabilityStatementMessagingComponent>	getMessaging()
CapabilityStatement.CapabilityStatementMessagingComponent	getMessagingFirstRep()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
List<CodeType>	getPatchFormat()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getPublisher()
StringType	getPublisherElement()
String	getPurpose()
MarkdownType	getPurposeElement()
ResourceType	getResourceType()
List<CapabilityStatement.CapabilityStatementRestComponent>	getRest()
CapabilityStatement.CapabilityStatementRestComponent	getRestFirstRep()
CapabilityStatement.CapabilityStatementSoftwareComponent	getSoftware()
Enumerations.PublicationStatus	getStatus()
Enumeration<Enumerations.PublicationStatus>	getStatusElement()
String	getTitle()
StringType	getTitleElement()
String[]	getTypesForProperty(int hash, String name)
String	getUrl()
UriType	getUrlElement()
List<UsageContext>	getUseContext()
UsageContext	getUseContextFirstRep()
String	getVersion()
StringType	getVersionElement()
boolean	hasContact()
boolean	hasCopyright()
boolean	hasCopyrightElement()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasDocument()
boolean	hasExperimental()
boolean	hasExperimentalElement()
boolean	hasFhirVersion()
boolean	hasFhirVersionElement()
boolean	hasFormat()
boolean	hasFormat(String value)
boolean	hasImplementation()
boolean	hasImplementationGuide()
boolean	hasImplementationGuide(String value)
boolean	hasImports()
boolean	hasImports(String value)
boolean	hasInstantiates()
boolean	hasInstantiates(String value)
boolean	hasJurisdiction()
boolean	hasKind()
boolean	hasKindElement()
boolean	hasMessaging()
boolean	hasName()
boolean	hasNameElement()
boolean	hasPatchFormat()
boolean	hasPatchFormat(String value)
boolean	hasPublisher()
boolean	hasPublisherElement()
boolean	hasPurpose()
boolean	hasPurposeElement()
boolean	hasRest()
boolean	hasSoftware()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasTitle()
boolean	hasTitleElement()
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)
CapabilityStatement	setContact(List<ContactDetail> theContact)
CapabilityStatement	setCopyright(String value)
CapabilityStatement	setCopyrightElement(MarkdownType value)
CapabilityStatement	setDate(Date value)
CapabilityStatement	setDateElement(DateTimeType value)
CapabilityStatement	setDescription(String value)
CapabilityStatement	setDescriptionElement(MarkdownType value)
CapabilityStatement	setDocument(List<CapabilityStatement.CapabilityStatementDocumentComponent> theDocument)
CapabilityStatement	setExperimental(boolean value)
CapabilityStatement	setExperimentalElement(BooleanType value)
CapabilityStatement	setFhirVersion(Enumerations.FHIRVersion value)
CapabilityStatement	setFhirVersionElement(Enumeration<Enumerations.FHIRVersion> value)
CapabilityStatement	setFormat(List<CodeType> theFormat)
CapabilityStatement	setImplementation(CapabilityStatement.CapabilityStatementImplementationComponent value)
CapabilityStatement	setImplementationGuide(List<CanonicalType> theImplementationGuide)
CapabilityStatement	setImports(List<CanonicalType> theImports)
CapabilityStatement	setInstantiates(List<CanonicalType> theInstantiates)
CapabilityStatement	setJurisdiction(List<CodeableConcept> theJurisdiction)
CapabilityStatement	setKind(CapabilityStatement.CapabilityStatementKind value)
CapabilityStatement	setKindElement(Enumeration<CapabilityStatement.CapabilityStatementKind> value)
CapabilityStatement	setMessaging(List<CapabilityStatement.CapabilityStatementMessagingComponent> theMessaging)
CapabilityStatement	setName(String value)
CapabilityStatement	setNameElement(StringType value)
CapabilityStatement	setPatchFormat(List<CodeType> thePatchFormat)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CapabilityStatement	setPublisher(String value)
CapabilityStatement	setPublisherElement(StringType value)
CapabilityStatement	setPurpose(String value)
CapabilityStatement	setPurposeElement(MarkdownType value)
CapabilityStatement	setRest(List<CapabilityStatement.CapabilityStatementRestComponent> theRest)
CapabilityStatement	setSoftware(CapabilityStatement.CapabilityStatementSoftwareComponent value)
CapabilityStatement	setStatus(Enumerations.PublicationStatus value)
CapabilityStatement	setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
CapabilityStatement	setTitle(String value)
CapabilityStatement	setTitleElement(StringType value)
CapabilityStatement	setUrl(String value)
CapabilityStatement	setUrlElement(UriType value)
CapabilityStatement	setUseContext(List<UsageContext> theUseContext)
CapabilityStatement	setVersion(String value)
CapabilityStatement	setVersionElement(StringType value)
protected CapabilityStatement	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

purpose

protected MarkdownType purpose

Explanation of why this capability statement is needed and why it has been designed as it has.

copyright

protected MarkdownType copyright

A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.

kind

protected Enumeration<CapabilityStatement.CapabilityStatementKind> kind

The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).

instantiates

protected List<CanonicalType> instantiates

Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.

imports

protected List<CanonicalType> imports

Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.

software

protected CapabilityStatement.CapabilityStatementSoftwareComponent software

Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.

implementation

protected CapabilityStatement.CapabilityStatementImplementationComponent implementation

Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.

fhirVersion

protected Enumeration<Enumerations.FHIRVersion> fhirVersion

The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.

format

protected List<CodeType> format

A list of the formats supported by this implementation using their content types.

patchFormat

protected List<CodeType> patchFormat

A list of the patch formats supported by this implementation using their content types.

implementationGuide

protected List<CanonicalType> implementationGuide

A list of implementation guides that the server does (or should) support in their entirety.

rest

protected List<CapabilityStatement.CapabilityStatementRestComponent> rest

A definition of the restful capabilities of the solution, if any.

messaging

protected List<CapabilityStatement.CapabilityStatementMessagingComponent> messaging

A description of the messaging capabilities of the solution.

document

protected List<CapabilityStatement.CapabilityStatementDocumentComponent> document

A document definition.

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: The capability statement publication date
Type: date
Path: CapabilityStatement.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 capability statement publication date
Type: date
Path: CapabilityStatement.date

SP_RESOURCE_PROFILE

public static final String SP_RESOURCE_PROFILE

Search parameter: resource-profile

Description: A profile id invoked in a capability statement
Type: reference
Path: CapabilityStatement.rest.resource.profile

See Also:

• Constant Field Values

RESOURCE_PROFILE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RESOURCE_PROFILE

Fluent Client search parameter constant for resource-profile

Description: A profile id invoked in a capability statement
Type: reference
Path: CapabilityStatement.rest.resource.profile

INCLUDE_RESOURCE_PROFILE

public static final ca.uhn.fhir.model.api.Include INCLUDE_RESOURCE_PROFILE

Constant for fluent queries to be used to add include statements. Specifies the path value of "CapabilityStatement:resource-profile".

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 capability statement
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 capability statement
Type: composite
Path:

SP_SOFTWARE

public static final String SP_SOFTWARE

Search parameter: software

Description: Part of the name of a software application
Type: string
Path: CapabilityStatement.software.name

See Also:

• Constant Field Values

SOFTWARE

public static final ca.uhn.fhir.rest.gclient.StringClientParam SOFTWARE

Fluent Client search parameter constant for software

Description: Part of the name of a software application
Type: string
Path: CapabilityStatement.software.name

SP_RESOURCE

public static final String SP_RESOURCE

Search parameter: resource

Description: Name of a resource mentioned in a capability statement
Type: token
Path: CapabilityStatement.rest.resource.type

See Also:

• Constant Field Values

RESOURCE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam RESOURCE

Fluent Client search parameter constant for resource

Description: Name of a resource mentioned in a capability statement
Type: token
Path: CapabilityStatement.rest.resource.type

SP_JURISDICTION

public static final String SP_JURISDICTION

Search parameter: jurisdiction

Description: Intended jurisdiction for the capability statement
Type: token
Path: CapabilityStatement.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 capability statement
Type: token
Path: CapabilityStatement.jurisdiction

SP_FORMAT

public static final String SP_FORMAT

Search parameter: format

Description: formats supported (xml | json | ttl | mime type)
Type: token
Path: CapabilityStatement.format

See Also:

• Constant Field Values

FORMAT

public static final ca.uhn.fhir.rest.gclient.TokenClientParam FORMAT

Fluent Client search parameter constant for format

Description: formats supported (xml | json | ttl | mime type)
Type: token
Path: CapabilityStatement.format

SP_DESCRIPTION

public static final String SP_DESCRIPTION

Search parameter: description

Description: The description of the capability statement
Type: string
Path: CapabilityStatement.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 capability statement
Type: string
Path: CapabilityStatement.description

SP_CONTEXT_TYPE

public static final String SP_CONTEXT_TYPE

Search parameter: context-type

Description: A type of use context assigned to the capability statement
Type: token
Path: CapabilityStatement.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 capability statement
Type: token
Path: CapabilityStatement.useContext.code

SP_TITLE

public static final String SP_TITLE

Search parameter: title

Description: The human-friendly name of the capability statement
Type: string
Path: CapabilityStatement.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 capability statement
Type: string
Path: CapabilityStatement.title

SP_FHIRVERSION

public static final String SP_FHIRVERSION

Search parameter: fhirversion

Description: The version of FHIR
Type: token
Path: CapabilityStatement.version

See Also:

• Constant Field Values

FHIRVERSION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam FHIRVERSION

Fluent Client search parameter constant for fhirversion

Description: The version of FHIR
Type: token
Path: CapabilityStatement.version

SP_VERSION

public static final String SP_VERSION

Search parameter: version

Description: The business version of the capability statement
Type: token
Path: CapabilityStatement.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 capability statement
Type: token
Path: CapabilityStatement.version

SP_URL

public static final String SP_URL

Search parameter: url

Description: The uri that identifies the capability statement
Type: uri
Path: CapabilityStatement.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 capability statement
Type: uri
Path: CapabilityStatement.url

SP_SUPPORTED_PROFILE

public static final String SP_SUPPORTED_PROFILE

Search parameter: supported-profile

Description: Profiles for use cases supported
Type: reference
Path: CapabilityStatement.rest.resource.supportedProfile

See Also:

• Constant Field Values

SUPPORTED_PROFILE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUPPORTED_PROFILE

Fluent Client search parameter constant for supported-profile

Description: Profiles for use cases supported
Type: reference
Path: CapabilityStatement.rest.resource.supportedProfile

INCLUDE_SUPPORTED_PROFILE

public static final ca.uhn.fhir.model.api.Include INCLUDE_SUPPORTED_PROFILE

Constant for fluent queries to be used to add include statements. Specifies the path value of "CapabilityStatement:supported-profile".

SP_MODE

public static final String SP_MODE

Search parameter: mode

Description: Mode - restful (server/client) or messaging (sender/receiver)
Type: token
Path: CapabilityStatement.rest.mode

See Also:

• Constant Field Values

MODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam MODE

Fluent Client search parameter constant for mode

Description: Mode - restful (server/client) or messaging (sender/receiver)
Type: token
Path: CapabilityStatement.rest.mode

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 capability statement
Type: quantity
Path: CapabilityStatement.useContext.valueQuantity, CapabilityStatement.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 capability statement
Type: quantity
Path: CapabilityStatement.useContext.valueQuantity, CapabilityStatement.useContext.valueRange

SP_SECURITY_SERVICE

public static final String SP_SECURITY_SERVICE

Search parameter: security-service

Description: OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
Type: token
Path: CapabilityStatement.rest.security.service

See Also:

• Constant Field Values

SECURITY_SERVICE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam SECURITY_SERVICE

Fluent Client search parameter constant for security-service

Description: OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
Type: token
Path: CapabilityStatement.rest.security.service

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: Computationally friendly name of the capability statement
Type: string
Path: CapabilityStatement.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 capability statement
Type: string
Path: CapabilityStatement.name

SP_CONTEXT

public static final String SP_CONTEXT

Search parameter: context

Description: A use context assigned to the capability statement
Type: token
Path: CapabilityStatement.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 capability statement
Type: token
Path: CapabilityStatement.useContext.valueCodeableConcept

SP_PUBLISHER

public static final String SP_PUBLISHER

Search parameter: publisher

Description: Name of the publisher of the capability statement
Type: string
Path: CapabilityStatement.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 capability statement
Type: string
Path: CapabilityStatement.publisher

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 capability statement
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 capability statement
Type: composite
Path:

SP_GUIDE

public static final String SP_GUIDE

Search parameter: guide

Description: Implementation guides supported
Type: reference
Path: CapabilityStatement.implementationGuide

See Also:

• Constant Field Values

GUIDE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam GUIDE

Fluent Client search parameter constant for guide

Description: Implementation guides supported
Type: reference
Path: CapabilityStatement.implementationGuide

INCLUDE_GUIDE

public static final ca.uhn.fhir.model.api.Include INCLUDE_GUIDE

Constant for fluent queries to be used to add include statements. Specifies the path value of "CapabilityStatement:guide".

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The current status of the capability statement
Type: token
Path: CapabilityStatement.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 capability statement
Type: token
Path: CapabilityStatement.status

Constructor Details

CapabilityStatement

public CapabilityStatement()

Constructor

CapabilityStatement

public CapabilityStatement(Enumeration<Enumerations.PublicationStatus> status,
 DateTimeType date,
 Enumeration<CapabilityStatement.CapabilityStatementKind> kind,
 Enumeration<Enumerations.FHIRVersion> fhirVersion)

Constructor

Method Details

getUrlElement

public UriType getUrlElement()

Overrides:

getUrlElement in class MetadataResource

Returns:

MetadataResource.url (An absolute URI that is used to identify this capability statement 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 capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement 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 CapabilityStatement setUrlElement(UriType value)

Overrides:

setUrlElement in class MetadataResource

Parameters:

value - MetadataResource.url (An absolute URI that is used to identify this capability statement 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 capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement 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 capability statement 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 capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers.

setUrl

public CapabilityStatement setUrl(String value)

Overrides:

setUrl in class MetadataResource

Parameters:

value - An absolute URI that is used to identify this capability statement 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 capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers.

getVersionElement

public StringType getVersionElement()

Overrides:

getVersionElement in class MetadataResource

Returns:

MetadataResource.version (The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement 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 CapabilityStatement setVersionElement(StringType value)

Overrides:

setVersionElement in class MetadataResource

Parameters:

value - MetadataResource.version (The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement 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 capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement 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 CapabilityStatement setVersion(String value)

Overrides:

setVersion in class MetadataResource

Parameters:

value - The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement 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 capability statement. 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 CapabilityStatement setNameElement(StringType value)

Overrides:

setNameElement in class MetadataResource

Parameters:

value - MetadataResource.name (A natural language name identifying the capability statement. 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 capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.

setName

public CapabilityStatement setName(String value)

Overrides:

setName in class MetadataResource

Parameters:

value - A natural language name identifying the capability statement. 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 capability statement.). 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 CapabilityStatement setTitleElement(StringType value)

Overrides:

setTitleElement in class MetadataResource

Parameters:

value - MetadataResource.title (A short, descriptive, user-friendly title for the capability statement.). 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 capability statement.

setTitle

public CapabilityStatement setTitle(String value)

Overrides:

setTitle in class MetadataResource

Parameters:

value - A short, descriptive, user-friendly title for the capability statement.

getStatusElement

public Enumeration<Enumerations.PublicationStatus> getStatusElement()

Overrides:

getStatusElement in class MetadataResource

Returns:

MetadataResource.status (The status of this capability statement. 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 CapabilityStatement setStatusElement(Enumeration<Enumerations.PublicationStatus> value)

Overrides:

setStatusElement in class MetadataResource

Parameters:

value - MetadataResource.status (The status of this capability statement. 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 capability statement. Enables tracking the life-cycle of the content.

setStatus

public CapabilityStatement setStatus(Enumerations.PublicationStatus value)

Overrides:

setStatus in class MetadataResource

Parameters:

value - The status of this capability statement. 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 capability statement 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 CapabilityStatement setExperimentalElement(BooleanType value)

Overrides:

setExperimentalElement in class MetadataResource

Parameters:

value - MetadataResource.experimental (A Boolean value to indicate that this capability statement 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 capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

setExperimental

public CapabilityStatement setExperimental(boolean value)

Overrides:

setExperimental in class MetadataResource

Parameters:

value - A Boolean value to indicate that this capability statement 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 capability statement 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 capability statement 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 CapabilityStatement setDateElement(DateTimeType value)

Overrides:

setDateElement in class MetadataResource

Parameters:

value - MetadataResource.date (The date (and optionally time) when the capability statement 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 capability statement 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 capability statement 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 capability statement changes.

setDate

public CapabilityStatement setDate(Date value)

Overrides:

setDate in class MetadataResource

Parameters:

value - The date (and optionally time) when the capability statement 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 capability statement changes.

getPublisherElement

public StringType getPublisherElement()

Overrides:

getPublisherElement in class MetadataResource

Returns:

MetadataResource.publisher (The name of the organization or individual that published the capability statement.). 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 CapabilityStatement setPublisherElement(StringType value)

Overrides:

setPublisherElement in class MetadataResource

Parameters:

value - MetadataResource.publisher (The name of the organization or individual that published the capability statement.). 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 capability statement.

setPublisher

public CapabilityStatement setPublisher(String value)

Overrides:

setPublisher in class MetadataResource

Parameters:

value - The name of the organization or individual that published the capability statement.

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 CapabilityStatement 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 CapabilityStatement 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 capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.). 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 CapabilityStatement setDescriptionElement(MarkdownType value)

Overrides:

setDescriptionElement in class MetadataResource

Parameters:

value - MetadataResource.description (A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.). 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 capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.

setDescription

public CapabilityStatement setDescription(String value)

Overrides:

setDescription in class MetadataResource

Parameters:

value - A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.

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 capability statement instances.)

setUseContext

public CapabilityStatement 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 CapabilityStatement 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 capability statement is intended to be used.)

setJurisdiction

public CapabilityStatement 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 CapabilityStatement 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 capability statement 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 CapabilityStatement setPurposeElement(MarkdownType value)

Parameters:

value - purpose (Explanation of why this capability statement 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 capability statement is needed and why it has been designed as it has.

setPurpose

public CapabilityStatement setPurpose(String value)

Parameters:

value - Explanation of why this capability statement is needed and why it has been designed as it has.

getCopyrightElement

public MarkdownType getCopyrightElement()

Returns:

copyright (A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.). 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 CapabilityStatement setCopyrightElement(MarkdownType value)

Parameters:

value - copyright (A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.). 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 capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.

setCopyright

public CapabilityStatement setCopyright(String value)

Parameters:

value - A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.

getKindElement

public Enumeration<CapabilityStatement.CapabilityStatementKind> getKindElement()

Returns:

kind (The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).). 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 CapabilityStatement setKindElement(Enumeration<CapabilityStatement.CapabilityStatementKind> value)

Parameters:

value - kind (The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value

getKind

public CapabilityStatement.CapabilityStatementKind getKind()

Returns:

The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).

setKind

public CapabilityStatement setKind(CapabilityStatement.CapabilityStatementKind value)

Parameters:

value - The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).

getInstantiates

public List<CanonicalType> getInstantiates()

Returns:

instantiates (Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.)

setInstantiates

public CapabilityStatement setInstantiates(List<CanonicalType> theInstantiates)

Returns:

Returns a reference to this for easy method chaining

hasInstantiates

public boolean hasInstantiates()

addInstantiatesElement

public CanonicalType addInstantiatesElement()

Returns:

instantiates (Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.)

addInstantiates

public CapabilityStatement addInstantiates(String value)

Parameters:

value - instantiates (Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.)

hasInstantiates

public boolean hasInstantiates(String value)

Parameters:

value - instantiates (Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.)

getImports

public List<CanonicalType> getImports()

Returns:

imports (Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.)

setImports

public CapabilityStatement setImports(List<CanonicalType> theImports)

Returns:

Returns a reference to this for easy method chaining

hasImports

public boolean hasImports()

addImportsElement

public CanonicalType addImportsElement()

Returns:

imports (Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.)

addImports

public CapabilityStatement addImports(String value)

Parameters:

value - imports (Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.)

hasImports

public boolean hasImports(String value)

Parameters:

value - imports (Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.)

getSoftware

public CapabilityStatement.CapabilityStatementSoftwareComponent getSoftware()

Returns:

software (Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.)

hasSoftware

public boolean hasSoftware()

setSoftware

public CapabilityStatement setSoftware(CapabilityStatement.CapabilityStatementSoftwareComponent value)

Parameters:

value - software (Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.)

getImplementation

public CapabilityStatement.CapabilityStatementImplementationComponent getImplementation()

Returns:

implementation (Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.)

hasImplementation

public boolean hasImplementation()

setImplementation

public CapabilityStatement setImplementation(CapabilityStatement.CapabilityStatementImplementationComponent value)

Parameters:

value - implementation (Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.)

getFhirVersionElement

public Enumeration<Enumerations.FHIRVersion> getFhirVersionElement()

Returns:

fhirVersion (The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.). 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 CapabilityStatement setFhirVersionElement(Enumeration<Enumerations.FHIRVersion> value)

Parameters:

value - fhirVersion (The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.). 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 that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.

setFhirVersion

public CapabilityStatement setFhirVersion(Enumerations.FHIRVersion value)

Parameters:

value - The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.

getFormat

public List<CodeType> getFormat()

Returns:

format (A list of the formats supported by this implementation using their content types.)

setFormat

public CapabilityStatement setFormat(List<CodeType> theFormat)

Returns:

Returns a reference to this for easy method chaining

hasFormat

public boolean hasFormat()

addFormatElement

public CodeType addFormatElement()

Returns:

format (A list of the formats supported by this implementation using their content types.)

addFormat

public CapabilityStatement addFormat(String value)

Parameters:

value - format (A list of the formats supported by this implementation using their content types.)

hasFormat

public boolean hasFormat(String value)

Parameters:

value - format (A list of the formats supported by this implementation using their content types.)

getPatchFormat

public List<CodeType> getPatchFormat()

Returns:

patchFormat (A list of the patch formats supported by this implementation using their content types.)

setPatchFormat

public CapabilityStatement setPatchFormat(List<CodeType> thePatchFormat)

Returns:

Returns a reference to this for easy method chaining

hasPatchFormat

public boolean hasPatchFormat()

addPatchFormatElement

public CodeType addPatchFormatElement()

Returns:

patchFormat (A list of the patch formats supported by this implementation using their content types.)

addPatchFormat

public CapabilityStatement addPatchFormat(String value)

Parameters:

value - patchFormat (A list of the patch formats supported by this implementation using their content types.)

hasPatchFormat

public boolean hasPatchFormat(String value)

Parameters:

value - patchFormat (A list of the patch formats supported by this implementation using their content types.)

getImplementationGuide

public List<CanonicalType> getImplementationGuide()

Returns:

implementationGuide (A list of implementation guides that the server does (or should) support in their entirety.)

setImplementationGuide

public CapabilityStatement setImplementationGuide(List<CanonicalType> theImplementationGuide)

Returns:

Returns a reference to this for easy method chaining

hasImplementationGuide

public boolean hasImplementationGuide()

addImplementationGuideElement

public CanonicalType addImplementationGuideElement()

Returns:

implementationGuide (A list of implementation guides that the server does (or should) support in their entirety.)

addImplementationGuide

public CapabilityStatement addImplementationGuide(String value)

Parameters:

value - implementationGuide (A list of implementation guides that the server does (or should) support in their entirety.)

hasImplementationGuide

public boolean hasImplementationGuide(String value)

Parameters:

value - implementationGuide (A list of implementation guides that the server does (or should) support in their entirety.)

getRest

public List<CapabilityStatement.CapabilityStatementRestComponent> getRest()

Returns:

rest (A definition of the restful capabilities of the solution, if any.)

setRest

public CapabilityStatement setRest(List<CapabilityStatement.CapabilityStatementRestComponent> theRest)

Returns:

Returns a reference to this for easy method chaining

hasRest

public boolean hasRest()

addRest

public CapabilityStatement.CapabilityStatementRestComponent addRest()

addRest

public CapabilityStatement addRest(CapabilityStatement.CapabilityStatementRestComponent t)

getRestFirstRep

public CapabilityStatement.CapabilityStatementRestComponent getRestFirstRep()

Returns:

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

getMessaging

public List<CapabilityStatement.CapabilityStatementMessagingComponent> getMessaging()

Returns:

messaging (A description of the messaging capabilities of the solution.)

setMessaging

public CapabilityStatement setMessaging(List<CapabilityStatement.CapabilityStatementMessagingComponent> theMessaging)

Returns:

Returns a reference to this for easy method chaining

hasMessaging

public boolean hasMessaging()

addMessaging

public CapabilityStatement.CapabilityStatementMessagingComponent addMessaging()

addMessaging

public CapabilityStatement addMessaging(CapabilityStatement.CapabilityStatementMessagingComponent t)

getMessagingFirstRep

public CapabilityStatement.CapabilityStatementMessagingComponent getMessagingFirstRep()

Returns:

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

getDocument

public List<CapabilityStatement.CapabilityStatementDocumentComponent> getDocument()

Returns:

document (A document definition.)

setDocument

public CapabilityStatement setDocument(List<CapabilityStatement.CapabilityStatementDocumentComponent> theDocument)

Returns:

Returns a reference to this for easy method chaining

hasDocument

public boolean hasDocument()

addDocument

public CapabilityStatement.CapabilityStatementDocumentComponent addDocument()

addDocument

public CapabilityStatement addDocument(CapabilityStatement.CapabilityStatementDocumentComponent t)

getDocumentFirstRep

public CapabilityStatement.CapabilityStatementDocumentComponent getDocumentFirstRep()

Returns:

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

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 CapabilityStatement copy()

Specified by:

copy in class MetadataResource

copyValues

public void copyValues(CapabilityStatement dst)

typedCopy

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