Message Index¶
This index lists all message object methods that apply to all Message Model types.
Note
For JSON-specific methods associated with the message object, see the JSON and FHIR index. For DICOM-specific methods associated with the message object, see the DICOM index.
message vs source objects:
Many methods exist in both the message and source objects.
- Use
source.*when:- You need to read values from the original incoming message.
- You want to reference the message before any mapping changes.
- Use
message.*when:- You want to read or modify the current working message.
- You are transforming the message during mapping.
- Important: changes made using
message.*do not modify the originalsourcemessage.
Index (signatures)¶
message methods¶
message.addChild(nodePath, childNode, value*, index*)message.addChildAfter(nodePath, childNode, value*)message.addChildBefore(nodePath, childNode, value*)message.addChildMessage(nodePath, childMessage)message.addCommandAttributes(otherDICOM)message.addFileMetaInformation(otherDICOM)message.addProlog(prolog*)message.checkNodeExists(nodePath, instance*, repetition*)message.checkNodeIsBlank(nodePath, instance*, repetition*)message.checkNodeIsNotBlank(nodePath, instance*, repetition*)message.createFileMetaInformation()message.discard()message.error(errorMessage, exception*)message.formatXML(indent)message.getASTMFieldCount(nodePath, instance*)message.getASTMRepetitionCount(nodePath, instance*)message.getAckMessage()message.getAllNodes(nodePath)message.getBytes()message.getColCount()message.getComponentSeparator()message.getCount(nodePath)message.getCreatedTimestamp()message.getElementSeparator()message.getErredTimestamp()message.getHL7FieldCount(nodePath, instance*)message.getHL7RepetitionCount(nodePath, instance*)message.getLastNode(nodePath)message.getMessageId()message.getNode(nodePath, instance*, repetition*)message.getNodeNamesMatchingPattern(nodePath)message.getRetryCount()message.getRowCount()message.getSegmentDelimiter()message.getSeparatePixelDataLength()message.isPixelDataStoredSeparately()message.length()message.quoteValues()message.removeAllNamespaces()message.removeAllNodes(nodePath)message.removeCommandAttributes()message.removeComments()message.removeFileMetaInformation()message.removeFirstNode(nodePath)message.removeLastNode(nodePath)message.removeNamespace(alias)message.removeProlog()message.removeWhitespace(includeEOL)message.retryDestination()message.setAckMessage(value)message.setAllNodes(nodePath, value)message.setBytes(value)message.setEndOfLine(eol)message.setNode(nodePath, value, instance*, repetition*, forceNode*)message.setPadCharacter(character)message.sortCSVByDate(sortNodePath, descending*)message.sortCSVByNumber(sortNodePath, descending*)message.sortCSVByString(sortNodePath, descending*)message.toString()message.unquoteValues()