HS.FHIRModel.R4.StructureDefinition
class HS.FHIRModel.R4.StructureDefinition extends HS.FHIRModel.FHIRClassSuper
******************************************* StructureDefinition generated class schema
*****************************************
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
- _abstract
- _contextInvariant
- _copyright
- _date
- _derivation
- _description
- _experimental
- _fhirVersion
- _implicitRules
- _kind
- _language
- _name
- _publisher
- _purpose
- _status
- _title
- _type
- _url
- _version
- abstract
- baseDefinition
- contact
- contained
- context
- contextInvariant
- copyright
- date
- derivation
- description
- differential
- experimental
- extension
- fhirID
- fhirVersion
- identifier
- implicitRules
- jurisdiction
- keyword
- kind
- language
- mapping
- meta
- modifierExtension
- name
- publisher
- purpose
- resourceType
- snapshot
- status
- text
- title
- type
- url
- useContext
- version
Method Inventory
- IncludeContact()
- IncludeContained()
- IncludeContext()
- IncludeContextInvariant()
- IncludeDifferential()
- IncludeExtension()
- IncludeIdentifier()
- IncludeJurisdiction()
- IncludeKeyword()
- IncludeMapping()
- IncludeMeta()
- IncludeModifierExtension()
- IncludeSnapshot()
- IncludeText()
- IncludeUseContext()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_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 HS.FHIRModel.R4.Element;
Extensions for abstract
Property methods: _abstractGet(), _abstractGetSwizzled(), _abstractIsValid(), _abstractNewObject(), _abstractSet()
property _contextInvariant as HS.FHIRModel.R4.SeqOfElement;
Extensions for contextInvariant
Property methods: _contextInvariantGet(), _contextInvariantGetSwizzled(), _contextInvariantIsValid(), _contextInvariantNewObject(), _contextInvariantSet()
property _copyright as HS.FHIRModel.R4.Element;
Extensions for copyright
Property methods: _copyrightGet(), _copyrightGetSwizzled(), _copyrightIsValid(), _copyrightNewObject(), _copyrightSet()
property _date as HS.FHIRModel.R4.Element;
Extensions for date
Property methods: _dateGet(), _dateGetSwizzled(), _dateIsValid(), _dateNewObject(), _dateSet()
property _derivation as HS.FHIRModel.R4.Element;
Extensions for derivation
Property methods: _derivationGet(), _derivationGetSwizzled(), _derivationIsValid(), _derivationNewObject(), _derivationSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _experimental as HS.FHIRModel.R4.Element;
Extensions for experimental
Property methods: _experimentalGet(), _experimentalGetSwizzled(), _experimentalIsValid(), _experimentalNewObject(), _experimentalSet()
property _fhirVersion as HS.FHIRModel.R4.Element;
Extensions for fhirVersion
Property methods: _fhirVersionGet(), _fhirVersionGetSwizzled(), _fhirVersionIsValid(), _fhirVersionNewObject(), _fhirVersionSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _kind as HS.FHIRModel.R4.Element;
Extensions for kind
Property methods: _kindGet(), _kindGetSwizzled(), _kindIsValid(), _kindNewObject(), _kindSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property _publisher as HS.FHIRModel.R4.Element;
Extensions for publisher
Property methods: _publisherGet(), _publisherGetSwizzled(), _publisherIsValid(), _publisherNewObject(), _publisherSet()
property _purpose as HS.FHIRModel.R4.Element;
Extensions for purpose
Property methods: _purposeGet(), _purposeGetSwizzled(), _purposeIsValid(), _purposeNewObject(), _purposeSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _title as HS.FHIRModel.R4.Element;
Extensions for title
Property methods: _titleGet(), _titleGetSwizzled(), _titleIsValid(), _titleNewObject(), _titleSet()
property _type as HS.FHIRModel.R4.Element;
Extensions for type
Property methods: _typeGet(), _typeGetSwizzled(), _typeIsValid(), _typeNewObject(), _typeSet()
property _url as HS.FHIRModel.R4.Element;
Extensions for url
Property methods: _urlGet(), _urlGetSwizzled(), _urlIsValid(), _urlNewObject(), _urlSet()
property _version as HS.FHIRModel.R4.Element;
Extensions for version
Property methods: _versionGet(), _versionGetSwizzled(), _versionIsValid(), _versionNewObject(), _versionSet()
property abstract as %Boolean;
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: abstractDisplayToLogical(), abstractGet(), abstractIsValid(), abstractLogicalToDisplay(), abstractLogicalToXSD(), abstractNormalize(), abstractSet(), abstractXSDToLogical()
property baseDefinition as %String;
An absolute URI that is the base structure from which this type is
derived, either by specialization or constraint.
Property methods: baseDefinitionDisplayToLogical(), baseDefinitionGet(), baseDefinitionIsValid(), baseDefinitionLogicalToDisplay(), baseDefinitionLogicalToOdbc(), baseDefinitionNormalize(), baseDefinitionSet()
property contact as HS.FHIRModel.R4.SeqOfContactDetail;
Contact details to assist a user in finding and communicating with
the publisher.
Property methods: contactGet(), contactGetSwizzled(), contactIsValid(), contactNewObject(), contactSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the
resource that contains them - they cannot be identified independently,
and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property context as HS.FHIRModel.R4.StructureDefinitionX.SeqOfStructureDefinitionXContext;
Identifies the types of resource or data type elements to which the
extension can be applied.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property contextInvariant as HS.FHIRModel.R4.SeqOfString;
A set of rules as FHIRPath Invariants about when the extension can
be used (e.g. co-occurrence variants for the extension). All the
rules must be true.
Property methods: contextInvariantGet(), contextInvariantGetSwizzled(), contextInvariantIsValid(), contextInvariantNewObject(), contextInvariantSet()
property copyright as %String;
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: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
property date as %String;
The date (and optionally time) when the structure definition was
published. The date must change 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: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property derivation as %String (VALUELIST = ",specialization,constraint");
How the type relates to the baseDefinition.
Property methods: derivationDisplayToLogical(), derivationGet(), derivationIsValid(), derivationLogicalToDisplay(), derivationLogicalToOdbc(), derivationNormalize(), derivationSet()
property description as %String;
A free text natural language description of the structure definition
from a consumer's perspective.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property differential as HS.FHIRModel.R4.StructureDefinitionX.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 experimental as %Boolean;
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: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property fhirVersion as %String (VALUELIST = ",0.01,0.05,0.06,0.11,0.0.80,0.0.81,0.0.82,0.4.0,0.5.0,1.0.0,1.0.1,1.0.2,1.1.0,1.4.0,1.6.0,1.8.0,3.0.0,3.0.1,3.3.0,3.5.0,4.0.0,4.0.1");
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
4.0.1. for this version.
Property methods: fhirVersionDisplayToLogical(), fhirVersionGet(), fhirVersionIsValid(), fhirVersionLogicalToDisplay(), fhirVersionLogicalToOdbc(), fhirVersionNormalize(), fhirVersionSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
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: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource
was constructed, and which must be understood when processing the
content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property jurisdiction as HS.FHIRModel.R4.SeqOfCodeableConcept;
A legal or geographic region in which the structure definition is
intended to be used.
Property methods: jurisdictionGet(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionNewObject(), jurisdictionSet()
property keyword as HS.FHIRModel.R4.SeqOfCoding;
A set of key words or terms from external terminologies that may
be used to assist with indexing and searching of templates nby describing
the use of this structure definition, or the content it describes.
Property methods: keywordGet(), keywordGetSwizzled(), keywordIsValid(), keywordNewObject(), keywordSet()
property kind as %String (VALUELIST = ",primitive-type,complex-type,resource,logical");
Defines the kind of structure that this definition is describing.
Property methods: kindDisplayToLogical(), kindGet(), kindIsValid(), kindLogicalToDisplay(), kindLogicalToOdbc(), kindNormalize(), kindSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property mapping as HS.FHIRModel.R4.StructureDefinitionX.SeqOfStructureDefinitionXMapping;
An external specification that the content is mapped to.
Property methods: mappingGet(), mappingGetSwizzled(), mappingIsValid(), mappingNewObject(), mappingSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained
by the infrastructure. Changes to the content might not always be
associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource and that modifies the understanding
of the element that contains it and/or the understanding of the
containing element's descendants. Usually modifier elements provide
negation or qualification. To make the use of extensions safe and
manageable, there is a strict set of governance applied to the definition
and use of extensions. Though any implementer is allowed to define
an extension, there is a set of requirements that SHALL be met as
part of the definition of the extension. Applications processing
a resource are required to check for modifier extensions. Modifier
extensions SHALL NOT change the meaning of any elements on Resource
or DomainResource (including cannot change the meaning of modifierExtension
itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property name as %String;
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: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property publisher as %String;
The name of the organization or individual that published the structure
definition.
Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property purpose as %String;
Explanation of why this structure definition is needed and why it
has been designed as it has.
Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property resourceType as %String [ InitialExpression = "StructureDefinition" , Required ];
This is a StructureDefinition resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property snapshot as HS.FHIRModel.R4.StructureDefinitionX.Snapshot;
A snapshot view is expressed in a standalone form that can be used
and interpreted without considering the base StructureDefinition.
Property methods: snapshotGet(), snapshotGetSwizzled(), snapshotIsValid(), snapshotNewObject(), snapshotSet()
property status as %String (VALUELIST = ",draft,active,retired,unknown");
The status of this structure definition. Enables tracking the life-cycle
of the content.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource
and can be used to represent the content of the resource to a human.
The narrative need not encode all the structured data, but is required
to contain sufficient detail to make it "clinically safe" for a
human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property title as %String;
A short, descriptive, user-friendly title for the structure definition.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property type as %String;
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).
References are URLs that are relative to http://hl7.org/fhir/StructureDefinition
e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string.
Absolute URLs are only allowed in logical models.
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property url as %String;
An absolute URI that is used to identify this structure definition
when it is referenced in a specification, model, design or an instance;
also called its canonical identifier. This SHOULD be globally unique
and SHOULD be a literal address at which at which an authoritative
instance of this structure definition is (or will be) published.
This URL can be the target of a canonical reference. It SHALL remain
the same when the structure definition is stored on different servers.
Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as HS.FHIRModel.R4.SeqOfUsageContext;
The content was developed with a focus and intent of supporting the
contexts that are listed. These contexts may be general categories
(gender, age, ...) or may be references to specific programs (insurance
plans, studies, ...) and may be used to assist with indexing and
searching for appropriate structure definition instances.
Property methods: useContextGet(), useContextGetSwizzled(), useContextIsValid(), useContextNewObject(), useContextSet()
property version as %String;
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: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()
Methods
method IncludeContact()
method IncludeContained()
method IncludeContext()
method IncludeContextInvariant()
method IncludeDifferential()
method IncludeExtension()
method IncludeIdentifier()
method IncludeJurisdiction()
method IncludeKeyword()
method IncludeMapping()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeSnapshot()
method IncludeText()
method IncludeUseContext()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.StructureDefinition
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()