Skip to main content

HS.FHIRModel.R4.GuidanceResponse

class HS.FHIRModel.R4.GuidanceResponse extends HS.FHIRModel.FHIRClassSuper

*****************************************
** GuidanceResponse generated class schema
*****************************************
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.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_GUIDANCERESPONSE;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _moduleCanonical as HS.FHIRModel.R4.Element;
Extensions for moduleCanonical
Property methods: _moduleCanonicalGet(), _moduleCanonicalGetSwizzled(), _moduleCanonicalIsValid(), _moduleCanonicalNewObject(), _moduleCanonicalSet()
property _moduleUri as HS.FHIRModel.R4.Element;
Extensions for moduleUri
Property methods: _moduleUriGet(), _moduleUriGetSwizzled(), _moduleUriIsValid(), _moduleUriNewObject(), _moduleUriSet()
property _occurrenceDateTime as HS.FHIRModel.R4.Element;
Extensions for occurrenceDateTime
Property methods: _occurrenceDateTimeGet(), _occurrenceDateTimeGetSwizzled(), _occurrenceDateTimeIsValid(), _occurrenceDateTimeNewObject(), _occurrenceDateTimeSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
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.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property dataRequirement as HS.FHIRModel.R4.SeqOfDataRequirement;
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.
Property methods: dataRequirementGet(), dataRequirementGetSwizzled(), dataRequirementIsValid(), dataRequirementNewObject(), dataRequirementSet()
property encounter as HS.FHIRModel.R4.Reference;
The encounter during which this response was created or to which the creation of this record is tightly associated.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property evaluationMessage as HS.FHIRModel.R4.SeqOfReference;
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.
Property methods: evaluationMessageGet(), evaluationMessageGetSwizzled(), evaluationMessageIsValid(), evaluationMessageNewObject(), evaluationMessageSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Allows a service to provide unique, business identifiers for the response.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
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.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.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.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
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).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property moduleCanonical as %String;
An identifier, CodeableConcept or canonical reference to the guidance that was requested.
Property methods: moduleCanonicalDisplayToLogical(), moduleCanonicalGet(), moduleCanonicalIsValid(), moduleCanonicalLogicalToDisplay(), moduleCanonicalLogicalToOdbc(), moduleCanonicalNormalize(), moduleCanonicalSet()
property moduleCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
An identifier, CodeableConcept or canonical reference to the guidance that was requested.
Property methods: moduleCodeableConceptGet(), moduleCodeableConceptGetSwizzled(), moduleCodeableConceptIsValid(), moduleCodeableConceptNewObject(), moduleCodeableConceptSet()
property moduleUri as %String;
An identifier, CodeableConcept or canonical reference to the guidance that was requested.
Property methods: moduleUriDisplayToLogical(), moduleUriGet(), moduleUriIsValid(), moduleUriLogicalToDisplay(), moduleUriLogicalToOdbc(), moduleUriNormalize(), moduleUriSet()
Provides a mechanism to communicate additional information about the response.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property occurrenceDateTime as %String;
Indicates when the guidance response was processed.
Property methods: occurrenceDateTimeDisplayToLogical(), occurrenceDateTimeGet(), occurrenceDateTimeIsValid(), occurrenceDateTimeLogicalToDisplay(), occurrenceDateTimeLogicalToOdbc(), occurrenceDateTimeNormalize(), occurrenceDateTimeSet()
property outputParameters as HS.FHIRModel.R4.Reference;
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.
Property methods: outputParametersGet(), outputParametersGetSwizzled(), outputParametersIsValid(), outputParametersNewObject(), outputParametersSet()
property performer as HS.FHIRModel.R4.Reference;
Provides a reference to the device that performed the guidance.
Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property reasonCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
Describes the reason for the guidance response in coded or textual form.
Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIRModel.R4.SeqOfReference;
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.
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property requestIdentifier as HS.FHIRModel.R4.Identifier;
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.
Property methods: requestIdentifierGet(), requestIdentifierGetSwizzled(), requestIdentifierIsValid(), requestIdentifierNewObject(), requestIdentifierSet()
property resourceType as %String [ InitialExpression = "GuidanceResponse" , Required ];
This is a GuidanceResponse resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property result as HS.FHIRModel.R4.Reference;
The actions, if any, produced by the evaluation of the artifact.
Property methods: resultGet(), resultGetSwizzled(), resultIsValid(), resultNewObject(), resultSet()
property status as %String (VALUELIST = ",success,data-requested,data-required,in-progress,failure,entered-in-error");
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.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIRModel.R4.Reference;
The patient for which the request was processed.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property text as HS.FHIRModel.R4.Narrative;
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.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeContained()
method IncludeDataRequirement()
method IncludeEncounter()
method IncludeEvaluationMessage()
method IncludeExtension()
method IncludeIdentifier()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeModuleCodeableConcept()
method IncludeNote()
method IncludeOutputParameters()
method IncludePerformer()
method IncludeReasonCode()
method IncludeReasonReference()
method IncludeRequestIdentifier()
method IncludeResult()
method IncludeSubject()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab