Skip to main content

HS.FHIR.DTL.vDSTU2.Model.Resource.StructureDefinition

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

Structural Definition.

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 = 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 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 = StructureDefinition;
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 abstract as %Boolean (XMLNAME = "abstract", XMLPROJECTION = "ATTRIBUTE") [ Required ];
boolean

Whether the structure is abstract.

Property methods: abstractDisplayToLogical(), abstractGet(), abstractIsValid(), abstractLogicalToDisplay(), abstractLogicalToXSD(), abstractNormalize(), abstractSet(), abstractXSDToLogical()
property base as %String (MAXLEN = 1000000, XMLNAME = "base", XMLPROJECTION = "ATTRIBUTE");
uri

Structure that this set of constraints applies to.

Property methods: baseDisplayToLogical(), baseGet(), baseIsValid(), baseLogicalToDisplay(), baseLogicalToOdbc(), baseNormalize(), baseSet()
property code as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.Coding (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
Coding

Assist with indexing and finding.

any FHIR2 code may be used; profile-code shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: codeBuildValueArray(), codeCollectionToDisplay(), codeCollectionToOdbc(), codeDisplayToCollection(), codeGet(), codeGetObject(), codeGetObjectId(), codeGetSwizzled(), codeIsValid(), codeOdbcToCollection(), codeSet(), codeSetObject(), codeSetObjectId()
property constrainedType as %String (MAXLEN = 1000000, XMLNAME = "constrainedType", XMLPROJECTION = "ATTRIBUTE");
code

Any datatype or resource, including abstract ones.

defined-types is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend defined-types and you may NOT use codes from other ValueSets.

Property methods: constrainedTypeDisplayToLogical(), constrainedTypeGet(), constrainedTypeIsValid(), constrainedTypeLogicalToDisplay(), constrainedTypeLogicalToOdbc(), constrainedTypeNormalize(), constrainedTypeSet()
property contact as list of HS.FHIR.DTL.vDSTU2.Model.Element.StructureDefinition.contact (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
BackboneElement

Contact details of the publisher.

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property context as list of %String (MAXLEN = 1000000, XMLNAME = "context", XMLPROJECTION = "ELEMENT");
string

Where the extension can be used in instances.

Property methods: contextBuildValueArray(), contextCollectionToDisplay(), contextCollectionToOdbc(), contextDisplayToCollection(), contextDisplayToLogical(), contextGet(), contextGetObject(), contextGetObjectId(), contextGetSwizzled(), contextIsValid(), contextLogicalToDisplay(), contextLogicalToOdbc(), contextNormalize(), contextOdbcToCollection(), contextSet(), contextSetObject(), contextSetObjectId(), contextTypeDisplayToLogical(), contextTypeGet(), contextTypeIsValid(), contextTypeLogicalToDisplay(), contextTypeLogicalToOdbc(), contextTypeNormalize(), contextTypeSet()
property contextType as %String (MAXLEN = 1000000, XMLNAME = "contextType", XMLPROJECTION = "ATTRIBUTE");
code

resource | datatype | mapping | extension

extension-context is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend extension-context and you may NOT use codes from other ValueSets.

Property methods: contextTypeDisplayToLogical(), contextTypeGet(), contextTypeIsValid(), contextTypeLogicalToDisplay(), contextTypeLogicalToOdbc(), contextTypeNormalize(), contextTypeSet()
string

Use and/or publishing restrictions.

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

Date for this version of the StructureDefinition.

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

Natural language description of the StructureDefinition.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property differential as HS.FHIR.DTL.vDSTU2.Model.Element.StructureDefinition.differential (XMLNAME = "differential", XMLPROJECTION = "ELEMENT");
BackboneElement

Differential view of the structure.

Property methods: differentialGet(), differentialGetSwizzled(), differentialIsValid(), differentialNewObject(), differentialSet()
property display as %String (MAXLEN = 1000000, XMLNAME = "display", XMLPROJECTION = "ATTRIBUTE");
string

Use this name when displaying the value.

Property methods: displayDisplayToLogical(), displayGet(), displayIsValid(), displayLogicalToDisplay(), displayLogicalToOdbc(), displayNormalize(), displaySet()
property experimental as %Boolean (XMLNAME = "experimental", XMLPROJECTION = "ATTRIBUTE");
boolean

If 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");
id

FHIR Version this StructureDefinition targets.

Property methods: fhirVersionDisplayToLogical(), fhirVersionGet(), fhirVersionIsValid(), fhirVersionLogicalToDisplay(), fhirVersionLogicalToOdbc(), fhirVersionNormalize(), fhirVersionSet()
property identifier as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Other identifiers for the StructureDefinition.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property kind as %String (MAXLEN = 1000000, XMLNAME = "kind", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

datatype | resource | logical

structure-definition-kind is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend structure-definition-kind and you may NOT use codes from other ValueSets.

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

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 %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE") [ Required ];
string

Informal name for this StructureDefinition.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
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 requirements as %String (MAXLEN = 1000000, XMLNAME = "requirements", XMLPROJECTION = "ATTRIBUTE");
string

Scope and Usage this structure definition is for.

Property methods: requirementsDisplayToLogical(), requirementsGet(), requirementsIsValid(), requirementsLogicalToDisplay(), requirementsLogicalToOdbc(), requirementsNormalize(), requirementsSet()
property snapshot as HS.FHIR.DTL.vDSTU2.Model.Element.StructureDefinition.snapshot (XMLNAME = "snapshot", XMLPROJECTION = "ELEMENT");
BackboneElement

Snapshot view of the structure.

Property methods: snapshotGet(), snapshotGetSwizzled(), snapshotIsValid(), snapshotNewObject(), snapshotSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | active | retired

conformance-resource-status is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend conformance-resource-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE") [ Required ];
uri

Absolute URL used to reference this StructureDefinition.

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

Content intends to support these contexts.

use-context is the REQUIRED FHIR2 ValueSet for codes, but if you need to express meanings not found in use-context, you may formally EXTEND use-context to add codes to it.

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

Logical id for this version of the StructureDefinition.

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

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab