Skip to main content

HS.FHIR.vDSTU2.Model.Resource.StructureDefinition

deprecated class HS.FHIR.vDSTU2.Model.Resource.StructureDefinition extends HS.FHIR.vDSTU2.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.

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 = StructureDefinition;
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 abstract as HS.FHIR.vDSTU2.Model.Datatype.Boolean (XMLNAME = "abstract") [ Required ];
Whether structure this definition describes is abstract or not - that is, whether an actual exchanged item can ever be of this type.
Property methods: abstractGet(), abstractGetSwizzled(), abstractIsValid(), abstractNewObject(), abstractSet()
property base as HS.FHIR.vDSTU2.Model.Datatype.Uri (XMLNAME = "base");
An absolute URI that is the base structure from which this set of constraints is derived.
Property methods: baseGet(), baseGetSwizzled(), baseIsValid(), baseNewObject(), baseSet()
property code as list of HS.FHIR.vDSTU2.Model.Base.Coding (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
A set of terms from external terminologies that may be used to assist with indexing and searching of templates.
Property methods: codeBuildValueArray(), codeCollectionToDisplay(), codeCollectionToOdbc(), codeDisplayToCollection(), codeGet(), codeGetObject(), codeGetObjectId(), codeGetSwizzled(), codeIsValid(), codeOdbcToCollection(), codeSet(), codeSetObject(), codeSetObjectId()
property constrainedType as HS.FHIR.vDSTU2.Model.Datatype.Code (XMLNAME = "constrainedType");
The type of type that is being constrained - a data type, an extension, a resource, including abstract ones. If this field is present, it indicates that the structure definition is a constraint. If it is not present, then the structure definition is the definition of a base structure.
Property methods: constrainedTypeGet(), constrainedTypeGetSwizzled(), constrainedTypeIsValid(), constrainedTypeNewObject(), constrainedTypeSet()
property contact as list of HS.FHIR.vDSTU2.Model.Resource.StructureDefinition.Contact (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
Contacts 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()
property context as list of HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
Identifies the types of resource or data type elements to which the extension can be applied.
Property methods: contextBuildValueArray(), contextCollectionToDisplay(), contextCollectionToOdbc(), contextDisplayToCollection(), contextGet(), contextGetObject(), contextGetObjectId(), contextGetSwizzled(), contextIsValid(), contextOdbcToCollection(), contextSet(), contextSetObject(), contextSetObjectId()
property contextType as HS.FHIR.vDSTU2.Model.Base.ExtensionContext (XMLNAME = "contextType");
If this is an extension, Identifies the context within FHIR resources where the extension can be used.
Property methods: contextTypeGet(), contextTypeGetSwizzled(), contextTypeIsValid(), contextTypeNewObject(), contextTypeSet()
A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.
Property methods: copyrightGet(), copyrightGetSwizzled(), copyrightIsValid(), copyrightNewObject(), copyrightSet()
property date as HS.FHIR.vDSTU2.Model.Datatype.DateTime (XMLNAME = "date") [ SqlFieldName = _date ];
The date this version of the structure definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes.
Property methods: dateGet(), dateGetSwizzled(), dateIsValid(), dateNewObject(), dateSet()
property description as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "description");
A free text natural language description of the StructureDefinition and its use.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property differential as HS.FHIR.vDSTU2.Model.Resource.StructureDefinition.Differential (XMLNAME = "differential");
A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.
Property methods: differentialGet(), differentialGetSwizzled(), differentialIsValid(), differentialNewObject(), differentialSet()
property display as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "display");
Defined so that applications can use this name when displaying the value of the extension to the user.
Property methods: displayGet(), displayGetSwizzled(), displayIsValid(), displayNewObject(), displaySet()
property experimental as HS.FHIR.vDSTU2.Model.Datatype.Boolean (XMLNAME = "experimental");
This StructureDefinition was 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.vDSTU2.Model.Datatype.Id (XMLNAME = "fhirVersion");
The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.1 for this version.
Property methods: fhirVersionGet(), fhirVersionGetSwizzled(), fhirVersionIsValid(), fhirVersionNewObject(), fhirVersionSet()
property identifier as list of HS.FHIR.vDSTU2.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Formal identifier that is used to identify this StructureDefinition when it is represented in other formats, or referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI), (if it's not possible to use the literal URI).
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property kind as HS.FHIR.vDSTU2.Model.Base.StructureDefinitionKind (XMLNAME = "kind") [ Required ];
Defines the kind of structure that this definition is describing.
Property methods: kindGet(), kindGetSwizzled(), kindIsValid(), kindNewObject(), kindSet()
property mapping as list of HS.FHIR.vDSTU2.Model.Resource.StructureDefinition.Mapping (XMLNAME = "mapping", XMLPROJECTION = "ELEMENT");
An external specification that the content is mapped to.
Property methods: mappingBuildValueArray(), mappingCollectionToDisplay(), mappingCollectionToOdbc(), mappingDisplayToCollection(), mappingGet(), mappingGetObject(), mappingGetObjectId(), mappingGetSwizzled(), mappingIsValid(), mappingOdbcToCollection(), mappingSet(), mappingSetObject(), mappingSetObjectId()
property name as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "name") [ Required ];
A free text natural language name identifying the StructureDefinition.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property publisher as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "publisher");
The name of the individual or organization that published the structure definition.
Property methods: publisherGet(), publisherGetSwizzled(), publisherIsValid(), publisherNewObject(), publisherSet()
property requirements as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "requirements");
Explains why this structure definition is needed and why it's been constrained as it has.
Property methods: requirementsGet(), requirementsGetSwizzled(), requirementsIsValid(), requirementsNewObject(), requirementsSet()
property snapshot as HS.FHIR.vDSTU2.Model.Resource.StructureDefinition.Snapshot (XMLNAME = "snapshot");
A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.
Property methods: snapshotGet(), snapshotGetSwizzled(), snapshotIsValid(), snapshotNewObject(), snapshotSet()
property status as HS.FHIR.vDSTU2.Model.Datatype.Code (XMLNAME = "status") [ Required ];
The status of the StructureDefinition.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property url as HS.FHIR.vDSTU2.Model.Datatype.Uri (XMLNAME = "url") [ Required ];
An absolute URL that is used to identify this structure definition 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 structure definition is (or will be) published.
Property methods: urlGet(), urlGetSwizzled(), urlIsValid(), urlNewObject(), urlSet()
property useContext as list of HS.FHIR.vDSTU2.Model.Base.CodeableConcept (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 of structure definitions.
Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "version");
The identifier that is used to identify this version of the StructureDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureDefinition author manually.
Property methods: versionGet(), versionGetSwizzled(), versionIsValid(), versionNewObject(), versionSet()

Methods

deprecated method SetAbstract(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 "abstract" property.
deprecated method SetBase(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 "base" property.
deprecated method SetCode(pCode As %String = "", pDisplay As %String = "", pSystem 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 "code" property.
deprecated method SetConstrainedType(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 "constrainedType" property.
deprecated method SetContext(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 "context" property.
deprecated method SetContextType(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 "contextType" 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 SetDisplay(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 "display" 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 SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" 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 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 SetRequirements(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 "requirements" 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 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 SetUseContext(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 "useContext" 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