Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

Thanks for your feedback!
Need to tell us more? Click here or use the Feedback button.

Is this page helpful?

Class Details

Parameters (5)
Properties (23)
Inherited Members

Show private members

HS.FHIR.DTL.vSTU3.Model.Resource.MessageDefinition

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

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

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 = MessageDefinition;

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 = 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 allowedResponse as list of HS.FHIR.DTL.vSTU3.Model.Element.MessageDefinition.allowedResponse (XMLNAME = "allowedResponse", XMLPROJECTION = "ELEMENT");

BackboneElement

Responses to this message.

Property methods: allowedResponseBuildValueArray(), allowedResponseCollectionToDisplay(), allowedResponseCollectionToOdbc(), allowedResponseDisplayToCollection(), allowedResponseGet(), allowedResponseGetObject(), allowedResponseGetObjectId(), allowedResponseGetSwizzled(), allowedResponseIsValid(), allowedResponseOdbcToCollection(), allowedResponseSet(), allowedResponseSetObject(), allowedResponseSetObjectId()

property base as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "base", XMLPROJECTION = "ELEMENT");

Reference

Definition this one is based on.

MessageDefinition

Property methods: baseGet(), baseGetSwizzled(), baseIsValid(), baseNewObject(), baseSet()

property category as %String (MAXLEN = 1000000, XMLNAME = "category", XMLPROJECTION = "ATTRIBUTE");

code

Consequence | Currency | Notification

message-significance-category is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend message-significance-category and you may NOT use codes from other ValueSets.

Property methods: categoryDisplayToLogical(), categoryGet(), categoryIsValid(), categoryLogicalToDisplay(), categoryLogicalToOdbc(), categoryNormalize(), categorySet()

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

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") [ Required ];

dateTime

Date this was last changed.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()

property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");

markdown

Natural language description of the message definition.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()

property event as HS.FHIR.DTL.vSTU3.Model.Datatype.Coding (XMLNAME = "event", XMLPROJECTION = "ELEMENT") [ Required ];

Coding

Event type.

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

Property methods: eventGet(), eventGetSwizzled(), eventIsValid(), eventNewObject(), eventSet()

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 focus as list of HS.FHIR.DTL.vSTU3.Model.Element.MessageDefinition.focus (XMLNAME = "focus", XMLPROJECTION = "ELEMENT");

BackboneElement

Resource(s) that are the subject of the event.

Property methods: focusBuildValueArray(), focusCollectionToDisplay(), focusCollectionToOdbc(), focusDisplayToCollection(), focusGet(), focusGetObject(), focusGetObjectId(), focusGetSwizzled(), focusIsValid(), focusOdbcToCollection(), focusSet(), focusSetObject(), focusSetObjectId()

property identifier as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Identifier

Additional identifier for the message definition.

Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()

property jurisdiction as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");

CodeableConcept

Intended jurisdiction for message 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 name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");

string

Name for this message definition (computer friendly)

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()

property parent as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "parent", XMLPROJECTION = "ELEMENT");

Reference

Protocol/workflow this is part of.

ActivityDefinition | PlanDefinition

Property methods: parentBuildValueArray(), parentCollectionToDisplay(), parentCollectionToOdbc(), parentDisplayToCollection(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentOdbcToCollection(), parentSet(), parentSetObject(), parentSetObjectId()

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 message definition is defined.

Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()

property replaces as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "replaces", XMLPROJECTION = "ELEMENT");

Reference

Takes the place of.

MessageDefinition

Property methods: replacesBuildValueArray(), replacesCollectionToDisplay(), replacesCollectionToOdbc(), replacesDisplayToCollection(), replacesGet(), replacesGetObject(), replacesGetObjectId(), replacesGetSwizzled(), replacesIsValid(), replacesOdbcToCollection(), replacesSet(), replacesSetObject(), replacesSetObjectId()

property responseRequired as %Boolean (XMLNAME = "responseRequired", XMLPROJECTION = "ATTRIBUTE");

boolean

Is a response required?

Property methods: responseRequiredDisplayToLogical(), responseRequiredGet(), responseRequiredIsValid(), responseRequiredLogicalToDisplay(), responseRequiredLogicalToXSD(), responseRequiredNormalize(), responseRequiredSet(), responseRequiredXSDToLogical()

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 message definition (human friendly)

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()

property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");

uri

Logical URI to reference this message 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 message definition.

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

Inherited Members

Inherited Properties

Inherited Methods

Feedback