HS.FHIRModel.R4.MessageDefinition
class HS.FHIRModel.R4.MessageDefinition extends HS.FHIRModel.FHIRClassSuper
******************************************* MessageDefinition generated class schema
*****************************************
Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
Property Inventory
- _category
- _copyright
- _date
- _description
- _eventUri
- _experimental
- _implicitRules
- _language
- _name
- _publisher
- _purpose
- _responseRequired
- _status
- _title
- _url
- _version
- allowedResponse
- base
- category
- contact
- contained
- copyright
- date
- description
- eventCoding
- eventUri
- experimental
- extension
- fhirID
- focus
- graph
- identifier
- implicitRules
- jurisdiction
- language
- meta
- modifierExtension
- name
- parent
- publisher
- purpose
- replaces
- resourceType
- responseRequired
- status
- text
- title
- url
- useContext
- version
Method Inventory
- IncludeAllowedResponse()
- IncludeContact()
- IncludeContained()
- IncludeEventCoding()
- IncludeExtension()
- IncludeFocus()
- IncludeGraph()
- IncludeIdentifier()
- IncludeJurisdiction()
- IncludeMeta()
- IncludeModifierExtension()
- IncludeParent()
- IncludeReplaces()
- IncludeText()
- IncludeUseContext()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_MESSAGEDEFINITION;
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 _category as HS.FHIRModel.R4.Element;
Extensions for category
Property methods: _categoryGet(), _categoryGetSwizzled(), _categoryIsValid(), _categoryNewObject(), _categorySet()
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 _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _eventUri as HS.FHIRModel.R4.Element;
Extensions for eventUri
Property methods: _eventUriGet(), _eventUriGetSwizzled(), _eventUriIsValid(), _eventUriNewObject(), _eventUriSet()
property _experimental as HS.FHIRModel.R4.Element;
Extensions for experimental
Property methods: _experimentalGet(), _experimentalGetSwizzled(), _experimentalIsValid(), _experimentalNewObject(), _experimentalSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
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 _responseRequired as HS.FHIRModel.R4.Element;
Extensions for responseRequired
Property methods: _responseRequiredGet(), _responseRequiredGetSwizzled(), _responseRequiredIsValid(), _responseRequiredNewObject(), _responseRequiredSet()
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 _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 allowedResponse as HS.FHIRModel.R4.MessageDefinitionX.SeqOfMessageDefinitionXAllowedResponse;
Indicates what types of messages may be sent as an application-level
response to this message.
Property methods: allowedResponseGet(), allowedResponseGetSwizzled(), allowedResponseIsValid(), allowedResponseNewObject(), allowedResponseSet()
property base as %String;
The MessageDefinition that is the basis for the contents of this
resource.
Property methods: baseDisplayToLogical(), baseGet(), baseIsValid(), baseLogicalToDisplay(), baseLogicalToOdbc(), baseNormalize(), baseSet()
property category as %String (VALUELIST = ",consequence,currency,notification");
The impact of the content of the message.
Property methods: categoryDisplayToLogical(), categoryGet(), categoryIsValid(), categoryLogicalToDisplay(), categoryLogicalToOdbc(), categoryNormalize(), categorySet()
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 copyright as %String;
A copyright statement relating to the message definition and/or its
contents. Copyright statements are generally legal restrictions
on the use and publishing of the message definition.
Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
property date as %String;
The date (and optionally time) when the message 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 message definition changes.
Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String;
A free text natural language description of the message definition
from a consumer's perspective.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property eventCoding as HS.FHIRModel.R4.Coding;
Event code or link to the EventDefinition.
Property methods: eventCodingGet(), eventCodingGetSwizzled(), eventCodingIsValid(), eventCodingNewObject(), eventCodingSet()
property eventUri as %String;
Event code or link to the EventDefinition.
Property methods: eventUriDisplayToLogical(), eventUriGet(), eventUriIsValid(), eventUriLogicalToDisplay(), eventUriLogicalToOdbc(), eventUriNormalize(), eventUriSet()
property experimental as %Boolean;
A Boolean value to indicate that this message 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 focus as HS.FHIRModel.R4.MessageDefinitionX.SeqOfMessageDefinitionXFocus;
Identifies the resource (or resources) that are being addressed by
the event. For example, the Encounter for an admit message or two
Account records for a merge.
Property methods: focusGet(), focusGetSwizzled(), focusIsValid(), focusNewObject(), focusSet()
property graph as HS.FHIRModel.R4.SeqOfString;
Canonical reference to a GraphDefinition. If a URL is provided, it
is the canonical reference to a [[[GraphDefinition]]] that it controls
what resources are to be added to the bundle when building the document.
The GraphDefinition can also specify profiles that apply to the
various resources.
Property methods: graphGet(), graphGetSwizzled(), graphIsValid(), graphNewObject(), graphSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
A formal identifier that is used to identify this message 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 message definition is intended
to be used.
Property methods: jurisdictionGet(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionNewObject(), jurisdictionSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
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 message 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 parent as HS.FHIRModel.R4.SeqOfString;
Identifies a protocol or workflow that this MessageDefinition represents
a step in.
Property methods: parentGet(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentSet()
property publisher as %String;
The name of the organization or individual that published the message
definition.
Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property purpose as %String;
Explanation of why this message definition is needed and why it has
been designed as it has.
Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property replaces as HS.FHIRModel.R4.SeqOfString;
A MessageDefinition that is superseded by this definition.
Property methods: replacesGet(), replacesGetSwizzled(), replacesIsValid(), replacesNewObject(), replacesSet()
property resourceType as %String [ InitialExpression = "MessageDefinition" , Required ];
This is a MessageDefinition resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property responseRequired as %String (VALUELIST = ",always,on-error,never,on-success");
Declare at a message definition level whether a response is required
or only upon error or success, or never.
Property methods: responseRequiredDisplayToLogical(), responseRequiredGet(), responseRequiredIsValid(), responseRequiredLogicalToDisplay(), responseRequiredLogicalToOdbc(), responseRequiredNormalize(), responseRequiredSet()
property status as %String (VALUELIST = ",draft,active,retired,unknown");
The status of this message 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 message definition.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property url as %String;
The business identifier that is used to reference the MessageDefinition
and *is* expected to be consistent from server to server.
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 message definition instances.
Property methods: useContextGet(), useContextGetSwizzled(), useContextIsValid(), useContextNewObject(), useContextSet()
property version as %String;
The identifier that is used to identify this version of the message
definition when it is referenced in a specification, model, design
or instance. This is an arbitrary value managed by the message 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 IncludeAllowedResponse()
method IncludeContact()
method IncludeContained()
method IncludeEventCoding()
method IncludeExtension()
method IncludeFocus()
method IncludeGraph()
method IncludeIdentifier()
method IncludeJurisdiction()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeParent()
method IncludeReplaces()
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.MessageDefinition
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()