Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.FHIR.DTL.vR4.Model.Resource.MessageDefinition

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

A resource that defines a type of message that can be exchanged between systems.

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.vR4.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 %String (MAXLEN = 1000000, XMLNAME = "base", XMLPROJECTION = "ATTRIBUTE");
canonical

Definition this one is based on.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: baseDisplayToLogical(), baseGet(), baseIsValid(), baseLogicalToDisplay(), baseLogicalToOdbc(), baseNormalize(), baseSet()
property category as %String (MAXLEN = 1000000, XMLNAME = "category", XMLPROJECTION = "ATTRIBUTE");
code

consequence | currency | notification

message-significance-category|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend message-significance-category|4.0.1 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.vR4.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()
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 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 eventCoding as HS.FHIR.DTL.vR4.Model.Datatype.Coding (XMLNAME = "eventCoding", XMLPROJECTION = "ELEMENT") [ Required ];
Coding

Event code or link to the EventDefinition.

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

Property methods: eventCodingGet(), eventCodingGetSwizzled(), eventCodingIsValid(), eventCodingNewObject(), eventCodingSet()
property eventUri as %String (MAXLEN = 1000000, XMLNAME = "eventUri", XMLPROJECTION = "ATTRIBUTE") [ Required ];
uri

Event code or link to the EventDefinition.

Property methods: eventUriDisplayToLogical(), eventUriGet(), eventUriIsValid(), eventUriLogicalToDisplay(), eventUriLogicalToOdbc(), eventUriNormalize(), eventUriSet()
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.vR4.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 graph as list of %String (MAXLEN = 1000000, XMLNAME = "graph", XMLPROJECTION = "ELEMENT");
canonical

Canonical reference to a GraphDefinition.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: graphBuildValueArray(), graphCollectionToDisplay(), graphCollectionToOdbc(), graphDisplayToCollection(), graphDisplayToLogical(), graphGet(), graphGetObject(), graphGetObjectId(), graphGetSwizzled(), graphIsValid(), graphLogicalToDisplay(), graphLogicalToOdbc(), graphNormalize(), graphOdbcToCollection(), graphSet(), graphSetObject(), graphSetObjectId()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Primary key for the message definition on a given server.

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

Intended jurisdiction for message definition (if applicable)

jurisdiction is the REQUIRED FHIR4 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 %String (MAXLEN = 1000000, XMLNAME = "parent", XMLPROJECTION = "ELEMENT");
canonical

Protocol/workflow this is part of.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: parentBuildValueArray(), parentCollectionToDisplay(), parentCollectionToOdbc(), parentDisplayToCollection(), parentDisplayToLogical(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentLogicalToDisplay(), parentLogicalToOdbc(), parentNormalize(), 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 %String (MAXLEN = 1000000, XMLNAME = "replaces", XMLPROJECTION = "ELEMENT");
canonical

Takes the place of.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: replacesBuildValueArray(), replacesCollectionToDisplay(), replacesCollectionToOdbc(), replacesDisplayToCollection(), replacesDisplayToLogical(), replacesGet(), replacesGetObject(), replacesGetObjectId(), replacesGetSwizzled(), replacesIsValid(), replacesLogicalToDisplay(), replacesLogicalToOdbc(), replacesNormalize(), replacesOdbcToCollection(), replacesSet(), replacesSetObject(), replacesSetObjectId()
property responseRequired as %String (MAXLEN = 1000000, XMLNAME = "responseRequired", XMLPROJECTION = "ATTRIBUTE");
code

always | on-error | never | on-success

messageheader-response-request|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend messageheader-response-request|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: responseRequiredDisplayToLogical(), responseRequiredGet(), responseRequiredIsValid(), responseRequiredLogicalToDisplay(), responseRequiredLogicalToOdbc(), responseRequiredNormalize(), responseRequiredSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | active | retired | unknown

publication-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend publication-status|4.0.1 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

Business Identifier for a given MessageDefinition.

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

The context that 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

FeedbackOpens in a new tab