GuidanceResponse class

GuidanceResponse A guidance response is the formal response to a

Mixed in types

• Resource

Annotations

• @freezed

Constructors

GuidanceResponse({@Default(R4ResourceType.GuidanceResponse) @JsonKey(unknownEnumValue: R4ResourceType.GuidanceResponse) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? 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, Identifier? requestIdentifier, List<Identifier>? identifier, FhirUri? moduleUri, @JsonKey(name: '_moduleUri') Element? moduleUriElement, FhirCanonical? moduleCanonical, @JsonKey(name: '_moduleCanonical') Element? moduleCanonicalElement, CodeableConcept? moduleCodeableConcept, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, Reference? subject, Reference? encounter, FhirDateTime? occurrenceDateTime, @JsonKey(name: '_occurrenceDateTime') Element? occurrenceDateTimeElement, Reference? performer, List<CodeableConcept>? reasonCode, List<Reference>? reasonReference, List<Annotation>? note, List<Reference>? evaluationMessage, Reference? outputParameters, Reference? result, List<DataRequirement>? dataRequirement})

GuidanceResponse A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.

const

factory

GuidanceResponse.fromJson(Map<String, dynamic> json)

Factory constructor, accepts Map<String, dynamic> as an argument

factory

GuidanceResponse.fromJsonString(String source)

Acts like a constructor, returns a GuidanceResponse, accepts a String as an argument, mostly because I got tired of typing it out

factory

GuidanceResponse.fromYaml(dynamic yaml)

Factory constructor that accepts a String in YAML format as an argument

factory

Properties

contained → List<Resource>?

contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

no setter, inherited

copyWith → $GuidanceResponseCopyWith<GuidanceResponse>

no setter, inherited

dataRequirement → List<DataRequirement>?

dataRequirement If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.

no setter, inherited

dbId → int?

no setter, inherited

encounter → Reference?

encounter The encounter during which this response was created or to which the creation of this record is tightly associated.

no setter, inherited

evaluationMessage → List<Reference>?

evaluationMessage Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.

no setter, inherited

extension_ → List<FhirExtension>?

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 manageable, 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 setter, inherited

fhirId → String?

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

identifier → List<Identifier>?

identifier Allows a service to provide unique, business identifiers for the response.

no setter, inherited

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 setter, inherited

implicitRulesElement → Element?

implicitRulesElement Extensions for implicitRules

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → Element?

languageElement Extensions for language

no setter, inherited

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 setter, inherited

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 manageable, 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 setter, inherited

moduleCanonical → FhirCanonical?

moduleCanonical An identifier, CodeableConcept or canonical reference to the guidance that was requested.

no setter, inherited

moduleCanonicalElement → Element?

moduleCanonicalElement Extensions for moduleCanonical

no setter, inherited

moduleCodeableConcept → CodeableConcept?

moduleCodeableConcept An identifier, CodeableConcept or canonical reference to the guidance that was requested.

no setter, inherited

moduleUri → FhirUri?

moduleUri An identifier, CodeableConcept or canonical reference to the guidance that was requested.

no setter, inherited

moduleUriElement → Element?

moduleUriElement Extensions for moduleUri

no setter, inherited

note → List<Annotation>?

note Provides a mechanism to communicate additional information about the response.

no setter, inherited

occurrenceDateTime → FhirDateTime?

occurrenceDateTime Indicates when the guidance response was processed.

no setter, inherited

occurrenceDateTimeElement → Element?

occurrenceDateTimeElement Extensions for occurrenceDateTime

no setter, inherited

outputParameters → Reference?

outputParameters The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.

no setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, inherited

performer → Reference?

performer Provides a reference to the device that performed the guidance.

no setter, inherited

reasonCode → List<CodeableConcept>?

reasonCode Describes the reason for the guidance response in coded or textual form.

no setter, inherited

reasonReference → List<Reference>?

reasonReference Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.

no setter, inherited

requestIdentifier → Identifier?

requestIdentifier The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.

no setter, inherited

resourceType → R4ResourceType

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

result → Reference?

result The actions, if any, produced by the evaluation of the artifact.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status → FhirCode?

status The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.

no setter, inherited

statusElement → Element?

statusElement Extensions for status

no setter, inherited

subject → Reference?

subject The patient for which the request was processed.

no setter, inherited

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 setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, inherited

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

inherited

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