Class MessageHeader
The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
Implements
Inherited Members
Namespace: fhirCsR2.Models
Assembly: fhirCsR2.dll
Syntax
public class MessageHeader : DomainResource, IFhirJsonSerializable
Properties
| Improve this Doc View Source_Timestamp
Extension container element for Timestamp
Declaration
public Element _Timestamp { get; set; }
Property Value
| Type | Description |
|---|---|
| Element |
Author
Need to know for audit/traceback requirements and possibly for authorization.
Declaration
public Reference Author { get; set; }
Property Value
| Type | Description |
|---|---|
| Reference |
Data
Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources.
Declaration
public List<Reference> Data { get; set; }
Property Value
| Type | Description |
|---|---|
| fhirCsR2.Models.List<Reference> |
Destination
Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient".
Declaration
public List<MessageHeaderDestination> Destination { get; set; }
Property Value
| Type | Description |
|---|---|
| fhirCsR2.Models.List<MessageHeaderDestination> |
Enterer
Need to know for audit/traceback requirements and possibly for authorization.
Declaration
public Reference Enterer { get; set; }
Property Value
| Type | Description |
|---|---|
| Reference |
Event
Drives the behavior associated with this message.
Declaration
public Coding Event { get; set; }
Property Value
| Type | Description |
|---|---|
| Coding |
Reason
Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.
Declaration
public CodeableConcept Reason { get; set; }
Property Value
| Type | Description |
|---|---|
| CodeableConcept |
Receiver
Allows routing beyond just the application level.
Declaration
public Reference Receiver { get; set; }
Property Value
| Type | Description |
|---|---|
| Reference |
ResourceType
Resource Type Name
Declaration
public override string ResourceType { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
| Improve this Doc View SourceResponse
Information about the message that this message is a response to. Only present if this message is a response.
Declaration
public MessageHeaderResponse Response { get; set; }
Property Value
| Type | Description |
|---|---|
| MessageHeaderResponse |
Responsible
Need to know for audit/traceback requirements and possibly for authorization.
Declaration
public Reference Responsible { get; set; }
Property Value
| Type | Description |
|---|---|
| Reference |
Source
Allows replies, supports audit.
Declaration
public MessageHeaderSource Source { get; set; }
Property Value
| Type | Description |
|---|---|
| MessageHeaderSource |
Timestamp
Allows limited detection of out-of-order and delayed transmission. Also supports audit.
Declaration
public string Timestamp { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Methods
| Improve this Doc View SourceDeserializeJson(ref Utf8JsonReader, JsonSerializerOptions)
Deserialize a JSON object
Declaration
public void DeserializeJson(ref Utf8JsonReader reader, JsonSerializerOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| Utf8JsonReader | reader | |
| JsonSerializerOptions | options |
DeserializeJsonProperty(ref Utf8JsonReader, JsonSerializerOptions, String)
Deserialize a JSON property
Declaration
public void DeserializeJsonProperty(ref Utf8JsonReader reader, JsonSerializerOptions options, string propertyName)
Parameters
| Type | Name | Description |
|---|---|---|
| Utf8JsonReader | reader | |
| JsonSerializerOptions | options | |
| System.String | propertyName |
SerializeJson(Utf8JsonWriter, JsonSerializerOptions, Boolean)
Serialize to a JSON object
Declaration
public void SerializeJson(Utf8JsonWriter writer, JsonSerializerOptions options, bool includeStartObject = true)
Parameters
| Type | Name | Description |
|---|---|---|
| Utf8JsonWriter | writer | |
| JsonSerializerOptions | options | |
| System.Boolean | includeStartObject |