VRDR .NET
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Properties | List of all members
VRDR.CauseOfDeathCodingMessage Class Reference

A CauseOfDeathCodingMessage that conveys the coded cause of death information of a decedent. More...

Inheritance diagram for VRDR.CauseOfDeathCodingMessage:
VRDR.BaseMessage VRDR.CauseOfDeathCodingUpdateMessage

Public Member Functions

 CauseOfDeathCodingMessage (DeathRecord record)
 Construct a CauseOfDeathCodingMessage from a record containing cause of death coded content. More...
 
 CauseOfDeathCodingMessage (BaseMessage messageToCode)
 Constructor that creates an CauseOfDeathCodingMessage for the specified submitted death record message. More...
 
 CauseOfDeathCodingMessage (string messageId, string destination, string status, string source="http://nchs.cdc.gov/vrdr_submission")
 Constructor that creates a CauseOfDeathCoding message for the specified message. More...
 
- Public Member Functions inherited from VRDR.BaseMessage
string ToXML (bool prettyPrint=false)
 Helper method to return a XML string representation of this DeathRecordSubmissionMessage. More...
 
string ToXml (bool prettyPrint=false)
 Helper method to return a XML string representation of this DeathRecordSubmissionMessage. More...
 
string ToJSON (bool prettyPrint=false)
 Helper method to return a JSON string representation of this DeathRecordSubmissionMessage. More...
 
string ToJson (bool prettyPrint=false)
 Helper method to return a JSON string representation of this DeathRecordSubmissionMessage. More...
 

Static Public Attributes

const String MESSAGE_TYPE = "http://nchs.cdc.gov/vrdr_causeofdeath_coding"
 The event URI for CauseOfDeathCodingMessage.
 

Properties

DeathRecord DeathRecord [get, set]
 The DeathRecord containing cause of death coded content conveyed by this message More...
 
override Bundle MessageBundleRecord [get]
 The record bundle that should go into the message bundle for this message More...
 
string CodedMessageId [get, set]
 The id of the death record submission/update message that was coded to produce the content of this message More...
 
- Properties inherited from VRDR.BaseMessage
Bundle MessageBundle [get, protected set]
 Bundle that contains the message.
 
virtual Bundle MessageBundleRecord [get]
 The record bundle that should go into the message bundle for this message More...
 
DateTimeOffset? MessageTimestamp [get, set]
 Message timestamp More...
 
string MessageId [get, set]
 Message Id More...
 
string MessageType [get, set]
 Message Type More...
 
string MessageSource [get, set]
 Message Source More...
 
string MessageDestination [get, set]
 Message Destination More...
 
List< string > MessageDestinations [get, set]
 Message Destinations More...
 
uint? CertNo [get, set]
 Jurisdiction-assigned death certificate number
 
string StateAuxiliaryId [get, set]
 Jurisdiction-assigned auxiliary identifier
 
uint? DeathYear [get, set]
 The year in which the death occurred
 
string JurisdictionId [get, set]
 Two character identifier of the jurisdiction in which the death occurred
 
string NCHSIdentifier [get]
 NCHS identifier. Format is 4-digit year, two character jurisdiction id, six character/digit certificate id.
 

Additional Inherited Members

- Static Public Member Functions inherited from VRDR.BaseMessage
static operator Bundle (BaseMessage message)
 Allow explicit casting of a message into a bundle More...
 
static T Parse< T > (StreamReader source, bool permissive=false)
 Parse an XML or JSON serialization of a FHIR Bundle and construct the appropriate subclass of BaseMessage. The new object is checked to ensure it the same or a subtype of the type parameter. More...
 
static T Parse< T > (Bundle bundle)
 Construct the appropriate subclass of BaseMessage based on a FHIR Bundle. The new object is checked to ensure it the same or a subtype of the type parameter. More...
 
static T Parse< T > (string source, bool permissive=false)
 Parse an XML or JSON serialization of a FHIR Bundle and construct the appropriate subclass of BaseMessage. The new object is checked to ensure it the same or a subtype of the type parameter. More...
 
static BaseMessage Parse (string source, bool permissive=false)
 Parse an XML or JSON serialization of a FHIR Bundle and construct the appropriate subclass of BaseMessage. Clients can use the typeof operator to determine the type of message object returned. More...
 
static BaseMessage ParseGenericMessage (string source, bool permissive=false)
 Parse an XML or JSON serialization of a FHIR Bundle and construct a generic BaseMessage. More...
 
static Bundle ParseGenericBundle (string source, bool permissive=false)
 Parse an XML or JSON serialization of a FHIR Bundle. More...
 
static BaseMessage Parse (Bundle bundle)
 Construct the appropriate subclass of BaseMessage based on a FHIR Bundle. Clients can use the typeof operator to determine the type of message object returned. More...
 
static BaseMessage Parse (StreamReader source, bool permissive=false)
 Parse an XML or JSON serialization of a FHIR Bundle and construct the appropriate subclass of BaseMessage. Clients can use the typeof operator to determine the type of message object returned. More...
 
static DeathRecord GetDeathRecordFromMessage (BaseMessage message)
 Convert message to message type and extract the death record More...
 
- Protected Member Functions inherited from VRDR.BaseMessage
 BaseMessage (Bundle messageBundle, bool ignoreMissingEntries=false, bool ignoreBundleType=false)
 Construct a BaseMessage from a FHIR Bundle. This constructor will also validate that the Bundle represents a FHIR message of the correct type. More...
 
findEntry< T > (bool ignoreMissingEntries=false)
 Find the first Entry within the message Bundle that contains a Resource of the specified type and return that resource. More...
 
 BaseMessage (String messageType)
 Constructor that creates a new, empty message for the specified message type.
 
void ExtractBusinessIdentifiers (DeathRecord from)
 Extract the business identifiers for the message from the supplied death record. More...
 
void UpdateMessageBundleRecord ()
 Update the record bundle in this message based on the MessageBundleRecord property (for whichever subclass we're instantiated as). Important if we're managing a death record that might have changed.
 
void SetSingleStringValue (string key, string value)
 Helper method to set a single string value on the Record portion of the Message
 
- Protected Attributes inherited from VRDR.BaseMessage
Parameters Record
 A Parameters entry that contains business identifiers for all messages plus additional information for Coding messages.
 
MessageHeader Header
 MessageHeader that contains the message header.
 

Detailed Description

A CauseOfDeathCodingMessage that conveys the coded cause of death information of a decedent.

Constructor & Destructor Documentation

◆ CauseOfDeathCodingMessage() [1/3]

VRDR.CauseOfDeathCodingMessage.CauseOfDeathCodingMessage ( DeathRecord  record)
inline

Construct a CauseOfDeathCodingMessage from a record containing cause of death coded content.

Parameters
recorda record containing cause of death coded content
Returns

◆ CauseOfDeathCodingMessage() [2/3]

VRDR.CauseOfDeathCodingMessage.CauseOfDeathCodingMessage ( BaseMessage  messageToCode)
inline

Constructor that creates an CauseOfDeathCodingMessage for the specified submitted death record message.

Parameters
messageToCodethe message to create coding response for.

◆ CauseOfDeathCodingMessage() [3/3]

VRDR.CauseOfDeathCodingMessage.CauseOfDeathCodingMessage ( string  messageId,
string  destination,
string  status,
string  source = "http://nchs.cdc.gov/vrdr_submission" 
)
inline

Constructor that creates a CauseOfDeathCoding message for the specified message.

Parameters
messageIdthe id of the message to code.
destinationthe endpoint identifier that the ack message will be sent to.
statusthe status being sent, from http://build.fhir.org/ig/nightingaleproject/vital_records_fhir_messaging_ig/branches/main/ValueSet-VRM-Status-vs.html
sourcethe endpoint identifier that the ack message will be sent from.

Property Documentation

◆ CodedMessageId

string VRDR.CauseOfDeathCodingMessage.CodedMessageId
getset

The id of the death record submission/update message that was coded to produce the content of this message

the message id.

◆ DeathRecord

DeathRecord VRDR.CauseOfDeathCodingMessage.DeathRecord
getset

The DeathRecord containing cause of death coded content conveyed by this message

the DeathRecord

◆ MessageBundleRecord

override Bundle VRDR.CauseOfDeathCodingMessage.MessageBundleRecord
getprotected

The record bundle that should go into the message bundle for this message

the MessageBundleRecord


The documentation for this class was generated from the following file: