Skip to main content

HS.FHIR.vSTU3.Model.Resource.CapabilityStatement

deprecated class HS.FHIR.vSTU3.Model.Resource.CapabilityStatement extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = CapabilityStatement;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property acceptUnknown as HS.FHIR.vSTU3.Model.Base.UnknownContentCode (XMLNAME = "acceptUnknown", XMLPROJECTION = "ELEMENT") [ Required ];
A code that indicates whether the application accepts unknown elements or extensions when reading resources.
Property methods: acceptUnknownGet(), acceptUnknownGetSwizzled(), acceptUnknownIsValid(), acceptUnknownNewObject(), acceptUnknownSet()
property contact as list of HS.FHIR.vSTU3.Model.Base.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
Contact details to assist a user in finding and communicating with the publisher.
Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
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.
Property methods: copyrightGet(), copyrightGetSwizzled(), copyrightIsValid(), copyrightNewObject(), copyrightSet()
property date as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "date", XMLPROJECTION = "ELEMENT") [ Required ];
The date (and optionally time) when the capability statement was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.
Property methods: dateGet(), dateGetSwizzled(), dateIsValid(), dateNewObject(), dateSet()
property description as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
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.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property document as list of HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Document (XMLNAME = "document", XMLPROJECTION = "ELEMENT");
A document definition.
Property methods: documentBuildValueArray(), documentCollectionToDisplay(), documentCollectionToOdbc(), documentDisplayToCollection(), documentGet(), documentGetObject(), documentGetObjectId(), documentGetSwizzled(), documentIsValid(), documentOdbcToCollection(), documentSet(), documentSetObject(), documentSetObjectId()
property experimental as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "experimental", XMLPROJECTION = "ELEMENT");
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.
Property methods: experimentalGet(), experimentalGetSwizzled(), experimentalIsValid(), experimentalNewObject(), experimentalSet()
property fhirVersion as HS.FHIR.vSTU3.Model.Datatype.Id (XMLNAME = "fhirVersion", XMLPROJECTION = "ELEMENT") [ Required ];
The version of the FHIR specification on which this capability statement is based.
Property methods: fhirVersionGet(), fhirVersionGetSwizzled(), fhirVersionIsValid(), fhirVersionNewObject(), fhirVersionSet()
property format as list of HS.FHIR.vSTU3.Model.Datatype.Code (XMLNAME = "format", XMLPROJECTION = "ELEMENT");
A list of the formats supported by this implementation using their content types.
Property methods: formatBuildValueArray(), formatCollectionToDisplay(), formatCollectionToOdbc(), formatDisplayToCollection(), formatGet(), formatGetObject(), formatGetObjectId(), formatGetSwizzled(), formatIsValid(), formatOdbcToCollection(), formatSet(), formatSetObject(), formatSetObjectId()
property implementation as HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Implementation (XMLNAME = "implementation", XMLPROJECTION = "ELEMENT");
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.
Property methods: implementationGet(), implementationGetSwizzled(), implementationGuideBuildValueArray(), implementationGuideCollectionToDisplay(), implementationGuideCollectionToOdbc(), implementationGuideDisplayToCollection(), implementationGuideGet(), implementationGuideGetObject(), implementationGuideGetObjectId(), implementationGuideGetSwizzled(), implementationGuideIsValid(), implementationGuideOdbcToCollection(), implementationGuideSet(), implementationGuideSetObject(), implementationGuideSetObjectId(), implementationIsValid(), implementationNewObject(), implementationSet()
property implementationGuide as list of HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "implementationGuide", XMLPROJECTION = "ELEMENT");
A list of implementation guides that the server does (or should) support in their entirety.
Property methods: implementationGuideBuildValueArray(), implementationGuideCollectionToDisplay(), implementationGuideCollectionToOdbc(), implementationGuideDisplayToCollection(), implementationGuideGet(), implementationGuideGetObject(), implementationGuideGetObjectId(), implementationGuideGetSwizzled(), implementationGuideIsValid(), implementationGuideOdbcToCollection(), implementationGuideSet(), implementationGuideSetObject(), implementationGuideSetObjectId()
property instantiates as list of HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "instantiates", XMLPROJECTION = "ELEMENT");
Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so.
Property methods: instantiatesBuildValueArray(), instantiatesCollectionToDisplay(), instantiatesCollectionToOdbc(), instantiatesDisplayToCollection(), instantiatesGet(), instantiatesGetObject(), instantiatesGetObjectId(), instantiatesGetSwizzled(), instantiatesIsValid(), instantiatesOdbcToCollection(), instantiatesSet(), instantiatesSetObject(), instantiatesSetObjectId()
property jurisdiction as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
A legal or geographic region in which the capability statement is intended to be used.
Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property kind as HS.FHIR.vSTU3.Model.Base.CapabilityStatementKind (XMLNAME = "kind", XMLPROJECTION = "ELEMENT") [ Required ];
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).
Property methods: kindGet(), kindGetSwizzled(), kindIsValid(), kindNewObject(), kindSet()
property messaging as list of HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Messaging (XMLNAME = "messaging", XMLPROJECTION = "ELEMENT");
A description of the messaging capabilities of the solution.
Property methods: messagingBuildValueArray(), messagingCollectionToDisplay(), messagingCollectionToOdbc(), messagingDisplayToCollection(), messagingGet(), messagingGetObject(), messagingGetObjectId(), messagingGetSwizzled(), messagingIsValid(), messagingOdbcToCollection(), messagingSet(), messagingSetObject(), messagingSetObjectId()
property name as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT");
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.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property patchFormat as list of HS.FHIR.vSTU3.Model.Datatype.Code (XMLNAME = "patchFormat", XMLPROJECTION = "ELEMENT");
A list of the patch formats supported by this implementation using their content types.
Property methods: patchFormatBuildValueArray(), patchFormatCollectionToDisplay(), patchFormatCollectionToOdbc(), patchFormatDisplayToCollection(), patchFormatGet(), patchFormatGetObject(), patchFormatGetObjectId(), patchFormatGetSwizzled(), patchFormatIsValid(), patchFormatOdbcToCollection(), patchFormatSet(), patchFormatSetObject(), patchFormatSetObjectId()
property profile as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "profile", XMLPROJECTION = "ELEMENT");
A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).
Property methods: profileBuildValueArray(), profileCollectionToDisplay(), profileCollectionToOdbc(), profileDisplayToCollection(), profileGet(), profileGetObject(), profileGetObjectId(), profileGetSwizzled(), profileIsValid(), profileOdbcToCollection(), profileSet(), profileSetObject(), profileSetObjectId()
property publisher as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "publisher", XMLPROJECTION = "ELEMENT");
The name of the individual or organization that published the capability statement.
Property methods: publisherGet(), publisherGetSwizzled(), publisherIsValid(), publisherNewObject(), publisherSet()
property purpose as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "purpose", XMLPROJECTION = "ELEMENT");
Explaination of why this capability statement is needed and why it has been designed as it has.
Property methods: purposeGet(), purposeGetSwizzled(), purposeIsValid(), purposeNewObject(), purposeSet()
property rest as list of HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Rest (XMLNAME = "rest", XMLPROJECTION = "ELEMENT");
A definition of the restful capabilities of the solution, if any.
Property methods: restBuildValueArray(), restCollectionToDisplay(), restCollectionToOdbc(), restDisplayToCollection(), restGet(), restGetObject(), restGetObjectId(), restGetSwizzled(), restIsValid(), restOdbcToCollection(), restSet(), restSetObject(), restSetObjectId()
property software as HS.FHIR.vSTU3.Model.Resource.CapabilityStatement.Software (XMLNAME = "software", XMLPROJECTION = "ELEMENT");
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.
Property methods: softwareGet(), softwareGetSwizzled(), softwareIsValid(), softwareNewObject(), softwareSet()
property status as HS.FHIR.vSTU3.Model.Base.PublicationStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The status of this capability statement. Enables tracking the life-cycle of the content.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property title as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "title", XMLPROJECTION = "ELEMENT");
A short, descriptive, user-friendly title for the capability statement.
Property methods: titleGet(), titleGetSwizzled(), titleIsValid(), titleNewObject(), titleSet()
property url as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "url", XMLPROJECTION = "ELEMENT");
An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions).
Property methods: urlGet(), urlGetSwizzled(), urlIsValid(), urlNewObject(), urlSet()
property useContext as list of HS.FHIR.vSTU3.Model.Base.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate capability statement instances.
Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "version", XMLPROJECTION = "ELEMENT");
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.
Property methods: versionGet(), versionGetSwizzled(), versionIsValid(), versionNewObject(), versionSet()

Methods

deprecated method SetAcceptUnknown(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "acceptUnknown" property.
deprecated method SetCopyright(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "copyright" property.
deprecated method SetDate(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "date" property.
deprecated method SetDescription(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "description" property.
deprecated method SetExperimental(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "experimental" property.
deprecated method SetFhirVersion(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "fhirVersion" property.
deprecated method SetFormat(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "format" property.
deprecated method SetImplementationGuide(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "implementationGuide" property.
deprecated method SetInstantiates(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "instantiates" property.
deprecated method SetJurisdiction(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "jurisdiction" property.
deprecated method SetKind(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "kind" property.
deprecated method SetName(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "name" property.
deprecated method SetPatchFormat(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "patchFormat" property.
deprecated method SetProfile(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "profile" property.
deprecated method SetPublisher(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "publisher" property.
deprecated method SetPurpose(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "purpose" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetTitle(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "title" property.
deprecated method SetUrl(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "url" property.
deprecated method SetVersion(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "version" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab