Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.CapabilityStatement

class HS.FHIR.DTL.vR4.Model.Resource.CapabilityStatement extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

A statement of system capabilities.

Property 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 XMLPROJECTION = ELEMENT;
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.
parameter XMLTYPE = CapabilityStatement;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property contact as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
ContactDetail

Contact details for the publisher.

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
markdown

Use and/or publishing restrictions.

Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE") [ Required ];
dateTime

Date last changed.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
markdown

Natural language description of the capability statement.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property document as list of HS.FHIR.DTL.vR4.Model.Element.CapabilityStatement.document (XMLNAME = "document", XMLPROJECTION = "ELEMENT");
BackboneElement

Document definition.

Property methods: documentBuildValueArray(), documentCollectionToDisplay(), documentCollectionToOdbc(), documentDisplayToCollection(), documentGet(), documentGetObject(), documentGetObjectId(), documentGetSwizzled(), documentIsValid(), documentOdbcToCollection(), documentSet(), documentSetObject(), documentSetObjectId()
property experimental as %Boolean (XMLNAME = "experimental", XMLPROJECTION = "ATTRIBUTE");
boolean

For testing purposes, not real usage.

Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property fhirVersion as %String (MAXLEN = 1000000, XMLNAME = "fhirVersion", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

FHIR Version the system supports.

FHIR-version|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend FHIR-version|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: fhirVersionDisplayToLogical(), fhirVersionGet(), fhirVersionIsValid(), fhirVersionLogicalToDisplay(), fhirVersionLogicalToOdbc(), fhirVersionNormalize(), fhirVersionSet()
property format as list of %String (MAXLEN = 1000000, XMLNAME = "format", XMLPROJECTION = "ELEMENT") [ Required ];
code

formats supported (xml | json | ttl | mime type)

mimetypes|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend mimetypes|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: formatBuildValueArray(), formatCollectionToDisplay(), formatCollectionToOdbc(), formatDisplayToCollection(), formatDisplayToLogical(), formatGet(), formatGetObject(), formatGetObjectId(), formatGetSwizzled(), formatIsValid(), formatLogicalToDisplay(), formatLogicalToOdbc(), formatNormalize(), formatOdbcToCollection(), formatSet(), formatSetObject(), formatSetObjectId()
property implementation as HS.FHIR.DTL.vR4.Model.Element.CapabilityStatement.implementation (XMLNAME = "implementation", XMLPROJECTION = "ELEMENT");
BackboneElement

If this describes a specific instance.

Property methods: implementationGet(), implementationGetSwizzled(), implementationGuideBuildValueArray(), implementationGuideCollectionToDisplay(), implementationGuideCollectionToOdbc(), implementationGuideDisplayToCollection(), implementationGuideDisplayToLogical(), implementationGuideGet(), implementationGuideGetObject(), implementationGuideGetObjectId(), implementationGuideGetSwizzled(), implementationGuideIsValid(), implementationGuideLogicalToDisplay(), implementationGuideLogicalToOdbc(), implementationGuideNormalize(), implementationGuideOdbcToCollection(), implementationGuideSet(), implementationGuideSetObject(), implementationGuideSetObjectId(), implementationIsValid(), implementationNewObject(), implementationSet()
property implementationGuide as list of %String (MAXLEN = 1000000, XMLNAME = "implementationGuide", XMLPROJECTION = "ELEMENT");
canonical

Implementation guides supported.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: implementationGuideBuildValueArray(), implementationGuideCollectionToDisplay(), implementationGuideCollectionToOdbc(), implementationGuideDisplayToCollection(), implementationGuideDisplayToLogical(), implementationGuideGet(), implementationGuideGetObject(), implementationGuideGetObjectId(), implementationGuideGetSwizzled(), implementationGuideIsValid(), implementationGuideLogicalToDisplay(), implementationGuideLogicalToOdbc(), implementationGuideNormalize(), implementationGuideOdbcToCollection(), implementationGuideSet(), implementationGuideSetObject(), implementationGuideSetObjectId()
property imports as list of %String (MAXLEN = 1000000, XMLNAME = "imports", XMLPROJECTION = "ELEMENT");
canonical

Canonical URL of another capability statement this adds to.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: importsBuildValueArray(), importsCollectionToDisplay(), importsCollectionToOdbc(), importsDisplayToCollection(), importsDisplayToLogical(), importsGet(), importsGetObject(), importsGetObjectId(), importsGetSwizzled(), importsIsValid(), importsLogicalToDisplay(), importsLogicalToOdbc(), importsNormalize(), importsOdbcToCollection(), importsSet(), importsSetObject(), importsSetObjectId()
property instantiates as list of %String (MAXLEN = 1000000, XMLNAME = "instantiates", XMLPROJECTION = "ELEMENT");
canonical

Canonical URL of another capability statement this implements.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: instantiatesBuildValueArray(), instantiatesCollectionToDisplay(), instantiatesCollectionToOdbc(), instantiatesDisplayToCollection(), instantiatesDisplayToLogical(), instantiatesGet(), instantiatesGetObject(), instantiatesGetObjectId(), instantiatesGetSwizzled(), instantiatesIsValid(), instantiatesLogicalToDisplay(), instantiatesLogicalToOdbc(), instantiatesNormalize(), instantiatesOdbcToCollection(), instantiatesSet(), instantiatesSetObject(), instantiatesSetObjectId()
property jurisdiction as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
CodeableConcept

Intended jurisdiction for capability statement (if applicable)

jurisdiction is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in jurisdiction, you may formally EXTEND jurisdiction to add codes to it.

Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property kind as %String (MAXLEN = 1000000, XMLNAME = "kind", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

instance | capability | requirements

capability-statement-kind|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend capability-statement-kind|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: kindDisplayToLogical(), kindGet(), kindIsValid(), kindLogicalToDisplay(), kindLogicalToOdbc(), kindNormalize(), kindSet()
property messaging as list of HS.FHIR.DTL.vR4.Model.Element.CapabilityStatement.messaging (XMLNAME = "messaging", XMLPROJECTION = "ELEMENT");
BackboneElement

If messaging is supported.

Property methods: messagingBuildValueArray(), messagingCollectionToDisplay(), messagingCollectionToOdbc(), messagingDisplayToCollection(), messagingGet(), messagingGetObject(), messagingGetObjectId(), messagingGetSwizzled(), messagingIsValid(), messagingOdbcToCollection(), messagingSet(), messagingSetObject(), messagingSetObjectId()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");
string

Name for this capability statement (computer friendly)

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property patchFormat as list of %String (MAXLEN = 1000000, XMLNAME = "patchFormat", XMLPROJECTION = "ELEMENT");
code

Patch formats supported.

mimetypes|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend mimetypes|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: patchFormatBuildValueArray(), patchFormatCollectionToDisplay(), patchFormatCollectionToOdbc(), patchFormatDisplayToCollection(), patchFormatDisplayToLogical(), patchFormatGet(), patchFormatGetObject(), patchFormatGetObjectId(), patchFormatGetSwizzled(), patchFormatIsValid(), patchFormatLogicalToDisplay(), patchFormatLogicalToOdbc(), patchFormatNormalize(), patchFormatOdbcToCollection(), patchFormatSet(), patchFormatSetObject(), patchFormatSetObjectId()
property publisher as %String (MAXLEN = 1000000, XMLNAME = "publisher", XMLPROJECTION = "ATTRIBUTE");
string

Name of the publisher (organization or individual)

Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property purpose as %String (MAXLEN = 1000000, XMLNAME = "purpose", XMLPROJECTION = "ATTRIBUTE");
markdown

Why this capability statement is defined.

Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property rest as list of HS.FHIR.DTL.vR4.Model.Element.CapabilityStatement.rest (XMLNAME = "rest", XMLPROJECTION = "ELEMENT");
BackboneElement

If the endpoint is a RESTful one.

Property methods: restBuildValueArray(), restCollectionToDisplay(), restCollectionToOdbc(), restDisplayToCollection(), restGet(), restGetObject(), restGetObjectId(), restGetSwizzled(), restIsValid(), restOdbcToCollection(), restSet(), restSetObject(), restSetObjectId()
property software as HS.FHIR.DTL.vR4.Model.Element.CapabilityStatement.software (XMLNAME = "software", XMLPROJECTION = "ELEMENT");
BackboneElement

Software that is covered by this capability statement.

Property methods: softwareGet(), softwareGetSwizzled(), softwareIsValid(), softwareNewObject(), softwareSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | active | retired | unknown

publication-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend publication-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE");
string

Name for this capability statement (human friendly)

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");
uri

Canonical identifier for this capability statement, represented as a URI (globally unique)

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as list of HS.FHIR.DTL.vR4.Model.Datatype.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
UsageContext

The context that the content is intended to support.

Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as %String (MAXLEN = 1000000, XMLNAME = "version", XMLPROJECTION = "ATTRIBUTE");
string

Business version of the capability statement.

Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab