MessageHeader 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.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
MessageHeader({@Default(R5ResourceType.MessageHeader) @JsonKey(unknownEnumValue: R5ResourceType.MessageHeader) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, Coding? eventCoding, FhirCanonical? eventCanonical, @JsonKey(name: '_eventCanonical') Element? eventCanonicalElement, List<MessageHeaderDestination> ? destination, Reference? sender, Reference? author, required MessageHeaderSource source, Reference? responsible, CodeableConcept? reason, MessageHeaderResponse? response, List<Reference> ? focus, FhirCanonical? definition}) -
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.
constfactory
-
MessageHeader.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- MessageHeader.fromJsonString(String source)
-
Acts like a constructor, returns a MessageHeader, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- MessageHeader.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
-
author The logical author of the message - the personor device that
decided the described event should happen. When there is more than one
candidate, pick the most proximal to the MessageHeader. Can provide
other authors in extensions.
no setterinherited
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it
is referenced by a resource that provides context/meaning.
no setterinherited
-
copyWith
→ $MessageHeaderCopyWith<
MessageHeader> -
no setterinherited
- dbId → int?
-
no setterinherited
- definition → FhirCanonical?
-
definition Permanent link to the MessageDefinition for this message.
no setterinherited
-
destination
→ List<
MessageHeaderDestination> ? -
destination The destination application which the message is intended
for.
no setterinherited
- eventCanonical → FhirCanonical?
-
eventCanonical Code that identifies the event this message represents
and connects it with its definition. Events defined as part of the
FHIR specification are defined by the implementation. Alternatively a
canonical uri to the EventDefinition.
no setterinherited
- eventCanonicalElement → Element?
-
eventCanonicalElement ("_eventCanonical") Extensions for
eventCanonical
no setterinherited
- eventCoding → Coding?
-
eventCoding Code that identifies the event this message represents
and connects it with its definition. Events defined as part of the
FHIR specification are defined by the implementation. Alternatively a
canonical uri to the EventDefinition.
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ ("extension") May be used to represent additional
information that is not part of the basic definition of the resource.
To make the use of extensions safe and managable, there is a strict
set of governance applied to the definition and use of extensions.
Though any implementer can define an extension, there is a set of
requirements that SHALL be met as part of the definition of the
extension.
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
-
focus
→ List<
Reference> ? -
focus The actual data of the message - a reference to the root/focus
class of the event. This is allowed to be a Parameters resource.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- implicitRules → FhirUri?
-
implicitRules A reference to a set of rules that were followed when
the resource was constructed, and which must be understood when
processing the content. Often, this is a reference to an
implementation guide that defines the special rules along with other
profiles etc.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
- meta → FhirMeta?
-
meta The metadata about the resource. This is content that is
maintained by the infrastructure. Changes to the content might not
always be associated with version changes to the resource.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
modifierExtension May be used to represent additional information
that is not part of the basic definition of the resource and that
modifies the understanding of the element that contains it and/or the
understanding of the containing element's descendants. Usually
modifier elements provide negation or qualification. To make the use
of extensions safe and managable, there is a strict set of governance
applied to the definition and use of extensions. Though any
implementer is allowed to define an extension, there is a set of
requirements that SHALL be met as part of the definition of the
extension. Applications processing a resource are required to check
for modifier extensions.Modifier extensions SHALL NOT change the
meaning of any elements on Resource or DomainResource (including
cannot change the meaning of modifierExtension itself).
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- reason → CodeableConcept?
-
reason Coded indication of the cause for the event - indicates a
reason for the occurrence of the event that is a focus of this message.
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a MessageHeader resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- response → MessageHeaderResponse?
-
response Information about the message that this message is a
response to. Only present if this message is a response.
no setterinherited
- responsible → Reference?
-
responsible The person or organization that accepts overall
responsibility for the contents of the message. The implication is
that the message event happened under the policies of the responsible
party.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sender → Reference?
-
sender Identifies the sending system to allow the use of a trust
relationship.
no setterinherited
- source → MessageHeaderSource
-
source The source application from which this message originated.
no setterinherited
- text → Narrative?
-
text A human-readable narrative that contains a summary of the
resource and can be used to represent the content of the resource to a
human. The narrative need not encode all the structured data, but is
required to contain sufficient detail to make it "clinically safe" for
a human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
override
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited