Data Model Libraries
    Preparing search index...

    Class GuidanceResponse

    GuidanceResponse Class

    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.

    The GuidanceResponse resource supports recording the results of decision support interactions, reportability determination for public health, as well as the communication of additional data requirements for subsequent interactions.

    FHIR Specification

    • Short: The formal response to a guidance request
    • Definition: 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.
    • FHIR Version: 5.0.0

    FHIR GuidanceResponse

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    requestIdentifier? identifier? module_ guidanceResponseStatusEnum status subject? encounter? occurrenceDateTime? performer? reason? note? evaluationMessage? outputParameters? result? dataRequirement?

    Methods

    parse getRequestIdentifier setRequestIdentifier hasRequestIdentifier getIdentifier setIdentifier addIdentifier hasIdentifier getModule setModule hasModule getModuleUriType hasModuleUriType getModuleCanonicalType hasModuleCanonicalType getModuleCodeableConcept hasModuleCodeableConcept getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getOccurrenceDateTimeElement setOccurrenceDateTimeElement hasOccurrenceDateTimeElement getOccurrenceDateTime setOccurrenceDateTime hasOccurrenceDateTime getPerformer setPerformer hasPerformer getReason setReason addReason hasReason getNote setNote addNote hasNote getEvaluationMessage setEvaluationMessage hasEvaluationMessage getOutputParameters setOutputParameters hasOutputParameters getResult setResult addResult hasResult getDataRequirement setDataRequirement addDataRequirement hasDataRequirement fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initReason initNote initResult initDataRequirement

    Constructors

    Properties

    requestIdentifier?: Identifier

    GuidanceResponse.requestIdentifier Element

    FHIR Specification

    • Short: The identifier of the request associated with this response, if any
    • Definition: 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.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    GuidanceResponse.identifier Element

    FHIR Specification

    • Short: Business identifier
    • Definition: Allows a service to provide unique, business identifiers for the response.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Privatemodule_

    module_: null | IDataType

    GuidanceResponse.module[x] Element

    @ChoiceDataTypesMeta('GuidanceResponse.module[x]', ['uri','canonical','CodeableConcept',]

    FHIR Specification

    • Short: What guidance was requested
    • Definition: An identifier, CodeableConcept or canonical reference to the guidance that was requested.
    • FHIR Types: 'uri', 'canonical', 'CodeableConcept',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    guidanceResponseStatusEnum: GuidanceResponseStatusEnum

    FHIR CodeSystem: GuidanceResponseStatus

    GuidanceResponseStatusEnum

    status: null | EnumCodeType

    GuidanceResponse.status Element

    FHIR Specification

    • Short: success | data-requested | data-required | in-progress | failure | entered-in-error
    • Definition: 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.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: GuidanceResponseStatusEnum

    subject?: Reference

    GuidanceResponse.subject Element

    FHIR Specification

    encounter?: Reference

    GuidanceResponse.encounter Element

    FHIR Specification

    • Short: Encounter during which the response was returned
    • Definition: The encounter during which this response was created or to which the creation of this record is tightly associated.
    • Comment: This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official copmletion of an encounter but still be tied to the context of the encounter.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    occurrenceDateTime?: DateTimeType

    GuidanceResponse.occurrenceDateTime Element

    FHIR Specification

    • Short: When the guidance response was processed
    • Definition: Indicates when the guidance response was processed.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    performer?: Reference

    GuidanceResponse.performer Element

    FHIR Specification

    • Short: Device returning the guidance
    • Definition: Provides a reference to the device that performed the guidance.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    reason?: CodeableReference[]

    GuidanceResponse.reason Element

    FHIR Specification

    • Short: Why guidance is needed
    • Definition: Describes the reason for the guidance response in coded or textual form, or 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.
    • Comment: Although this reference can be used to point to any resource, it is typically expected to refer to subject-specific data appropriate to the subject of the guidance. For example, patient-based decision support would be expected to reference patient-level data. In addition, implementations should provide as much detail as possible by using the http://hl7.org/fhir/StructureDefinition/targetElement and http://hl7.org/fhir/StructureDefinition/targetPath extensions to indicate the specific elements relevant to providing the reason for the guidance.
    • FHIR Type: CodeableReference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    GuidanceResponse.note Element

    FHIR Specification

    • Short: Additional notes about the response
    • Definition: Provides a mechanism to communicate additional information about the response.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    evaluationMessage?: Reference

    GuidanceResponse.evaluationMessage Element

    FHIR Specification

    • Short: Messages resulting from the evaluation of the artifact or artifacts
    • Definition: 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.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    outputParameters?: Reference

    GuidanceResponse.outputParameters Element

    FHIR Specification

    • Short: The output parameters of the evaluation, if any
    • Definition: 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.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    result?: Reference[]

    GuidanceResponse.result Element

    FHIR Specification

    dataRequirement?: DataRequirement[]

    GuidanceResponse.dataRequirement Element

    FHIR Specification

    • Short: Additional required data
    • Definition: 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.
    • FHIR Type: DataRequirement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided GuidanceResponse JSON to instantiate the GuidanceResponse data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR GuidanceResponse

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to GuidanceResponse

      Returns undefined | GuidanceResponse

      GuidanceResponse data model or undefined for GuidanceResponse

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the result property.

      Parameters

      • value: undefined | Reference[]

        the result array value

      Returns this

      this

      @ReferenceTargets('GuidanceResponse.result', ['Appointment','AppointmentResponse','CarePlan','Claim','CommunicationRequest','Contract','CoverageEligibilityRequest','DeviceRequest','EnrollmentRequest','ImmunizationRecommendation','MedicationRequest','NutritionOrder','RequestOrchestration','ServiceRequest','SupplyRequest','Task','VisionPrescription',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the result array property.

      Parameters

      • value: undefined | Reference

        the result value

      Returns this

      this

      @ReferenceTargets('GuidanceResponse.result', ['Appointment','AppointmentResponse','CarePlan','Claim','CommunicationRequest','Contract','CoverageEligibilityRequest','DeviceRequest','EnrollmentRequest','ImmunizationRecommendation','MedicationRequest','NutritionOrder','RequestOrchestration','ServiceRequest','SupplyRequest','Task','VisionPrescription',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetRequestIdentifiersetRequestIdentifierhasRequestIdentifiergetIdentifiersetIdentifieraddIdentifierhasIdentifiergetModulesetModulehasModulegetModuleUriTypehasModuleUriTypegetModuleCanonicalTypehasModuleCanonicalTypegetModuleCodeableConcepthasModuleCodeableConceptgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetOccurrenceDateTimeElementsetOccurrenceDateTimeElementhasOccurrenceDateTimeElementgetOccurrenceDateTimesetOccurrenceDateTimehasOccurrenceDateTimegetPerformersetPerformerhasPerformergetReasonsetReasonaddReasonhasReasongetNotesetNoteaddNotehasNotegetEvaluationMessagesetEvaluationMessagehasEvaluationMessagegetOutputParameterssetOutputParametershasOutputParametersgetResultsetResultaddResulthasResultgetDataRequirementsetDataRequirementaddDataRequirementhasDataRequirementfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitReasoninitNoteinitResultinitDataRequirement