Skip to main content


class HS.FHIR.DTL.vSTU3.Model.Resource.GuidanceResponse extends HS.FHIR.DTL.vSTU3.Model.Base.DomainResource

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


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = GuidanceResponse;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = 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.


property context as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");

Encounter or Episode during which the response was returned.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property dataRequirement as list of HS.FHIR.DTL.vSTU3.Model.Datatype.DataRequirement (XMLNAME = "dataRequirement", XMLPROJECTION = "ELEMENT");

Additional required data.

Property methods: dataRequirementBuildValueArray(), dataRequirementCollectionToDisplay(), dataRequirementCollectionToOdbc(), dataRequirementDisplayToCollection(), dataRequirementGet(), dataRequirementGetObject(), dataRequirementGetObjectId(), dataRequirementGetSwizzled(), dataRequirementIsValid(), dataRequirementOdbcToCollection(), dataRequirementSet(), dataRequirementSetObject(), dataRequirementSetObjectId()
property evaluationMessage as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "evaluationMessage", XMLPROJECTION = "ELEMENT");

Messages resulting from the evaluation of the artifact or artifacts.


Property methods: evaluationMessageBuildValueArray(), evaluationMessageCollectionToDisplay(), evaluationMessageCollectionToOdbc(), evaluationMessageDisplayToCollection(), evaluationMessageGet(), evaluationMessageGetObject(), evaluationMessageGetObjectId(), evaluationMessageGetSwizzled(), evaluationMessageIsValid(), evaluationMessageOdbcToCollection(), evaluationMessageSet(), evaluationMessageSetObject(), evaluationMessageSetObjectId()
property identifier as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Business identifier.

Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property module as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "module", XMLPROJECTION = "ELEMENT") [ Required ];

A reference to a knowledge module.


Property methods: moduleGet(), moduleGetSwizzled(), moduleIsValid(), moduleNewObject(), moduleSet()
property note as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");

Additional notes about the response.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property occurrenceDateTime as %String (MAXLEN = 1000000, XMLNAME = "occurrenceDateTime", XMLPROJECTION = "ATTRIBUTE");

When the guidance response was processed.

Property methods: occurrenceDateTimeDisplayToLogical(), occurrenceDateTimeGet(), occurrenceDateTimeIsValid(), occurrenceDateTimeLogicalToDisplay(), occurrenceDateTimeLogicalToOdbc(), occurrenceDateTimeNormalize(), occurrenceDateTimeSet()
property outputParameters as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "outputParameters", XMLPROJECTION = "ELEMENT");

The output parameters of the evaluation, if any.


Property methods: outputParametersGet(), outputParametersGetSwizzled(), outputParametersIsValid(), outputParametersNewObject(), outputParametersSet()
property performer as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");

Device returning the guidance.


Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property reasonCodeableConcept as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "reasonCodeableConcept", XMLPROJECTION = "ELEMENT");

Reason for the response.

any FHIR3 code from any ValueSet may be used.

Property methods: reasonCodeableConceptGet(), reasonCodeableConceptGetSwizzled(), reasonCodeableConceptIsValid(), reasonCodeableConceptNewObject(), reasonCodeableConceptSet()
property reasonReference as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");

Reason for the response.

Any FHIR3 Resource may be indicated by this Reference.

Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property requestId as %String (MAXLEN = 1000000, XMLNAME = "requestId", XMLPROJECTION = "ATTRIBUTE");

The id of the request associated with this response, if any.

Property methods: requestIdDisplayToLogical(), requestIdGet(), requestIdIsValid(), requestIdLogicalToDisplay(), requestIdLogicalToOdbc(), requestIdNormalize(), requestIdSet()
property result as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "result", XMLPROJECTION = "ELEMENT");

Proposed actions, if any.

CarePlan | RequestGroup

Property methods: resultGet(), resultGetSwizzled(), resultIsValid(), resultNewObject(), resultSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

success | data-requested | data-required | in-progress | failure | entered-in-error

guidance-response-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend guidance-response-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");

Patient the request was performed for.

Patient | Group

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab