Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.GuidanceResponse

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

The formal response to a guidance request.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
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 XMLPROJECTION = ELEMENT;
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.

Properties

property dataRequirement as list of HS.FHIR.DTL.vR4.Model.Datatype.DataRequirement (XMLNAME = "dataRequirement", XMLPROJECTION = "ELEMENT");
DataRequirement

Additional required data.

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

Encounter during which the response was returned.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property evaluationMessage as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "evaluationMessage", XMLPROJECTION = "ELEMENT");
Reference

Messages resulting from the evaluation of the artifact or artifacts.

OperationOutcome

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

Business identifier.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property moduleCanonical as %String (MAXLEN = 1000000, XMLNAME = "moduleCanonical", XMLPROJECTION = "ATTRIBUTE") [ Required ];
canonical

What guidance was requested.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: moduleCanonicalDisplayToLogical(), moduleCanonicalGet(), moduleCanonicalIsValid(), moduleCanonicalLogicalToDisplay(), moduleCanonicalLogicalToOdbc(), moduleCanonicalNormalize(), moduleCanonicalSet()
property moduleCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "moduleCodeableConcept", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

What guidance was requested.

any FHIR4 code from any ValueSet may be used.

Property methods: moduleCodeableConceptGet(), moduleCodeableConceptGetSwizzled(), moduleCodeableConceptIsValid(), moduleCodeableConceptNewObject(), moduleCodeableConceptSet()
property moduleUri as %String (MAXLEN = 1000000, XMLNAME = "moduleUri", XMLPROJECTION = "ATTRIBUTE") [ Required ];
uri

What guidance was requested.

Property methods: moduleUriDisplayToLogical(), moduleUriGet(), moduleUriIsValid(), moduleUriLogicalToDisplay(), moduleUriLogicalToOdbc(), moduleUriNormalize(), moduleUriSet()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

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");
dateTime

When the guidance response was processed.

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

The output parameters of the evaluation, if any.

Parameters

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

Device returning the guidance.

Device

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

Why guidance is needed.

any FHIR4 code from any ValueSet may be used.

Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Why guidance is needed.

Condition | Observation | DiagnosticReport | DocumentReference

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property requestIdentifier as HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "requestIdentifier", XMLPROJECTION = "ELEMENT");
Identifier

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

Property methods: requestIdentifierGet(), requestIdentifierGetSwizzled(), requestIdentifierIsValid(), requestIdentifierNewObject(), requestIdentifierSet()
property result as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "result", XMLPROJECTION = "ELEMENT");
Reference

Proposed actions, if any.

CarePlan | RequestGroup

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

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

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

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

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