Skip to main content

HS.FHIR.DTL.vSTU3.Model.Resource.StructureDefinition

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

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.

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 baseDefinition as %String (MAXLEN = 1000000, XMLNAME = "baseDefinition", XMLPROJECTION = "ATTRIBUTE");
uri

Definition that this type is constrained/specialized from.

Property methods: baseDefinitionDisplayToLogical(), baseDefinitionGet(), baseDefinitionIsValid(), baseDefinitionLogicalToDisplay(), baseDefinitionLogicalToOdbc(), baseDefinitionNormalize(), baseDefinitionSet()
property contact as list of HS.FHIR.DTL.vSTU3.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()
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(), contextInvariantBuildValueArray(), contextInvariantCollectionToDisplay(), contextInvariantCollectionToOdbc(), contextInvariantDisplayToCollection(), contextInvariantDisplayToLogical(), contextInvariantGet(), contextInvariantGetObject(), contextInvariantGetObjectId(), contextInvariantGetSwizzled(), contextInvariantIsValid(), contextInvariantLogicalToDisplay(), contextInvariantLogicalToOdbc(), contextInvariantNormalize(), contextInvariantOdbcToCollection(), contextInvariantSet(), contextInvariantSetObject(), contextInvariantSetObjectId(), contextIsValid(), contextLogicalToDisplay(), contextLogicalToOdbc(), contextNormalize(), contextOdbcToCollection(), contextSet(), contextSetObject(), contextSetObjectId(), contextTypeDisplayToLogical(), contextTypeGet(), contextTypeIsValid(), contextTypeLogicalToDisplay(), contextTypeLogicalToOdbc(), contextTypeNormalize(), contextTypeSet()
property contextInvariant as list of %String (MAXLEN = 1000000, XMLNAME = "contextInvariant", XMLPROJECTION = "ELEMENT");
string

FHIRPath invariants - when the extension can be used.

Property methods: contextInvariantBuildValueArray(), contextInvariantCollectionToDisplay(), contextInvariantCollectionToOdbc(), contextInvariantDisplayToCollection(), contextInvariantDisplayToLogical(), contextInvariantGet(), contextInvariantGetObject(), contextInvariantGetObjectId(), contextInvariantGetSwizzled(), contextInvariantIsValid(), contextInvariantLogicalToDisplay(), contextInvariantLogicalToOdbc(), contextInvariantNormalize(), contextInvariantOdbcToCollection(), contextInvariantSet(), contextInvariantSetObject(), contextInvariantSetObjectId()
property contextType as %String (MAXLEN = 1000000, XMLNAME = "contextType", XMLPROJECTION = "ATTRIBUTE");
code

resource | datatype | extension

extension-context is the REQUIRED FHIR3 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()
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");
dateTime

Date this was last changed.

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

specialization | constraint - How relates to base definition

type-derivation-rule is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend type-derivation-rule and you may NOT use codes from other ValueSets.

Property methods: derivationDisplayToLogical(), derivationGet(), derivationIsValid(), derivationLogicalToDisplay(), derivationLogicalToOdbc(), derivationNormalize(), derivationSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
markdown

Natural language description of the structure definition.

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

Differential view of the structure.

Property methods: differentialGet(), differentialGetSwizzled(), differentialIsValid(), differentialNewObject(), differentialSet()
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");
id

FHIR Version this StructureDefinition targets.

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

Additional identifier for the structure definition.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property jurisdiction as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
CodeableConcept

Intended jurisdiction for structure definition (if applicable)

jurisdiction is the REQUIRED FHIR3 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 keyword as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Coding (XMLNAME = "keyword", XMLPROJECTION = "ELEMENT");
Coding

Assist with indexing and finding.

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

Property methods: keywordBuildValueArray(), keywordCollectionToDisplay(), keywordCollectionToOdbc(), keywordDisplayToCollection(), keywordGet(), keywordGetObject(), keywordGetObjectId(), keywordGetSwizzled(), keywordIsValid(), keywordOdbcToCollection(), keywordSet(), keywordSetObject(), keywordSetObjectId()
property kind as %String (MAXLEN = 1000000, XMLNAME = "kind", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

primitive-type | complex-type | resource | logical

structure-definition-kind is the REQUIRED FHIR3 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.vSTU3.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

Name for this structure definition (computer friendly)

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 purpose as %String (MAXLEN = 1000000, XMLNAME = "purpose", XMLPROJECTION = "ATTRIBUTE");
markdown

Why this structure definition is defined.

Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property snapshot as HS.FHIR.DTL.vSTU3.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 | unknown

publication-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend publication-status 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 structure definition (human friendly)

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property type as %String (MAXLEN = 1000000, XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

Type defined or constrained by this structure.

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

Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE") [ Required ];
uri

Logical URI to reference this structure definition (globally unique)

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

Context 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 structure definition.

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

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab