Skip to main content

HS.FHIR.vSTU3.Model.Resource.StructureDefinition

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
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 = 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.vSTU3.Model.Datatype.Boolean (XMLNAME = "abstract", XMLPROJECTION = "ELEMENT") [ Required ];
Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.
Property methods: abstractGet(), abstractGetSwizzled(), abstractIsValid(), abstractNewObject(), abstractSet()
property baseDefinition as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "baseDefinition", XMLPROJECTION = "ELEMENT");
An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
Property methods: baseDefinitionGet(), baseDefinitionGetSwizzled(), baseDefinitionIsValid(), baseDefinitionNewObject(), baseDefinitionSet()
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()
property context as list of HS.FHIR.vSTU3.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(), contextInvariantBuildValueArray(), contextInvariantCollectionToDisplay(), contextInvariantCollectionToOdbc(), contextInvariantDisplayToCollection(), contextInvariantGet(), contextInvariantGetObject(), contextInvariantGetObjectId(), contextInvariantGetSwizzled(), contextInvariantIsValid(), contextInvariantOdbcToCollection(), contextInvariantSet(), contextInvariantSetObject(), contextInvariantSetObjectId(), contextIsValid(), contextOdbcToCollection(), contextSet(), contextSetObject(), contextSetObjectId(), contextTypeGet(), contextTypeGetSwizzled(), contextTypeIsValid(), contextTypeNewObject(), contextTypeSet()
property contextInvariant as list of HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "contextInvariant", XMLPROJECTION = "ELEMENT");
A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).
Property methods: contextInvariantBuildValueArray(), contextInvariantCollectionToDisplay(), contextInvariantCollectionToOdbc(), contextInvariantDisplayToCollection(), contextInvariantGet(), contextInvariantGetObject(), contextInvariantGetObjectId(), contextInvariantGetSwizzled(), contextInvariantIsValid(), contextInvariantOdbcToCollection(), contextInvariantSet(), contextInvariantSetObject(), contextInvariantSetObjectId()
property contextType as HS.FHIR.vSTU3.Model.Base.ExtensionContext (XMLNAME = "contextType", XMLPROJECTION = "ELEMENT");
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 structure definition.
Property methods: copyrightGet(), copyrightGetSwizzled(), copyrightIsValid(), copyrightNewObject(), copyrightSet()
property date as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "date", XMLPROJECTION = "ELEMENT");
The date (and optionally time) when the structure definition 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 structure definition changes.
Property methods: dateGet(), dateGetSwizzled(), dateIsValid(), dateNewObject(), dateSet()
property derivation as HS.FHIR.vSTU3.Model.Base.TypeDerivationRule (XMLNAME = "derivation", XMLPROJECTION = "ELEMENT");
How the type relates to the baseDefinition.
Property methods: derivationGet(), derivationGetSwizzled(), derivationIsValid(), derivationNewObject(), derivationSet()
property description as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
A free text natural language description of the structure definition from a consumer's perspective.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property differential as HS.FHIR.vSTU3.Model.Resource.StructureDefinition.Differential (XMLNAME = "differential", XMLPROJECTION = "ELEMENT");
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 experimental as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "experimental", XMLPROJECTION = "ELEMENT");
A boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
Property methods: experimentalGet(), experimentalGetSwizzled(), experimentalIsValid(), experimentalNewObject(), experimentalSet()
property fhirVersion as HS.FHIR.vSTU3.Model.Datatype.Id (XMLNAME = "fhirVersion", XMLPROJECTION = "ELEMENT");
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 3.0.1 for this version.
Property methods: fhirVersionGet(), fhirVersionGetSwizzled(), fhirVersionIsValid(), fhirVersionNewObject(), fhirVersionSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property jurisdiction as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
A legal or geographic region in which the structure definition is intended to be used.
Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property keyword as list of HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "keyword", XMLPROJECTION = "ELEMENT");
A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates.
Property methods: keywordBuildValueArray(), keywordCollectionToDisplay(), keywordCollectionToOdbc(), keywordDisplayToCollection(), keywordGet(), keywordGetObject(), keywordGetObjectId(), keywordGetSwizzled(), keywordIsValid(), keywordOdbcToCollection(), keywordSet(), keywordSetObject(), keywordSetObjectId()
property kind as HS.FHIR.vSTU3.Model.Base.StructureDefinitionKind (XMLNAME = "kind", XMLPROJECTION = "ELEMENT") [ 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.vSTU3.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.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT") [ Required ];
A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property publisher as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "publisher", XMLPROJECTION = "ELEMENT");
The name of the individual or organization that published the structure definition.
Property methods: publisherGet(), publisherGetSwizzled(), publisherIsValid(), publisherNewObject(), publisherSet()
property purpose as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "purpose", XMLPROJECTION = "ELEMENT");
Explaination of why this structure definition is needed and why it has been designed as it has.
Property methods: purposeGet(), purposeGetSwizzled(), purposeIsValid(), purposeNewObject(), purposeSet()
property snapshot as HS.FHIR.vSTU3.Model.Resource.StructureDefinition.Snapshot (XMLNAME = "snapshot", XMLPROJECTION = "ELEMENT");
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.vSTU3.Model.Base.PublicationStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The status of this structure definition. 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 structure definition.
Property methods: titleGet(), titleGetSwizzled(), titleIsValid(), titleNewObject(), titleSet()
property type as HS.FHIR.vSTU3.Model.Datatype.Code (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type).
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property url as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "url", XMLPROJECTION = "ELEMENT") [ Required ];
An absolute URI 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. The URL SHOULD include the major version of the structure definition. 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 structure definition 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 structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
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 SetBaseDefinition(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 "baseDefinition" 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 SetContextInvariant(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 "contextInvariant" 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 SetDerivation(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 "derivation" 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 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 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 SetKeyword(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 "keyword" 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 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 SetType(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 "type" 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