description: Base StructureDefinition for GuidanceResponse Resource
package_name: hl7.fhir.r2b.examples
derivation: specialization
name: GuidanceResponse
type: null
elements:
  requestId:
    isModifier: false
    short: The id of the request associated with this response, if any
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: GuidanceResponse.requestId}
    isSummary: false
    index: 0
  module:
    isModifier: true
    short: A reference to a knowledge module
    index: 1
    type: Reference
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: GuidanceResponse.module}
    isSummary: true
  status:
    isModifier: true
    short: success | data-requested | data-required | in-progress | failure
    index: 2
    type: code
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: GuidanceResponse.status}
    isSummary: true
  evaluationMessage:
    isModifier: false
    short: Messages resulting from the evaluation of the artifact or artifacts
    index: 3
    type: Reference
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: GuidanceResponse.evaluationMessage}
    isSummary: false
  outputParameters:
    isModifier: false
    short: The output parameters of the evaluation, if any
    type: Reference
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: GuidanceResponse.outputParameters}
    isSummary: false
    index: 4
  action:
    isModifier: false
    short: Proposed actions, if any
    index: 5
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      description:
        isModifier: false
        short: Short description of the action
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: GuidanceResponse.action.description}
        isSummary: false
        index: 9
      textEquivalent:
        isModifier: false
        short: Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: GuidanceResponse.action.textEquivalent}
        isSummary: false
        index: 10
      relatedAction:
        isModifier: false
        short: Relationship to another action
        index: 13
        type: BackboneElement
        mustSupport: false
        elements:
          actionIdentifier:
            isModifier: false
            short: Identifier of the related action
            index: 14
            type: Identifier
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: GuidanceResponse.action.relatedAction.actionIdentifier}
            isSummary: false
          relationship:
            isModifier: false
            short: before | after
            index: 15
            type: code
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: GuidanceResponse.action.relatedAction.relationship}
            isSummary: false
          offset:
            isModifier: false
            short: Time offset for the relationship
            mustSupport: false
            choices: [offsetQuantity, offsetRange]
            maxLength: 0
            base: {max: '1', min: 0, path: 'GuidanceResponse.action.relatedAction.offset[x]'}
            isSummary: false
            index: 17
          offsetQuantity:
            isModifier: false
            short: Time offset for the relationship
            index: 18
            type: Quantity
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: 'GuidanceResponse.action.relatedAction.offset[x]'}
            choiceOf: offset
            isSummary: false
          offsetRange:
            isModifier: false
            short: Time offset for the relationship
            index: 19
            type: Range
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: 'GuidanceResponse.action.relatedAction.offset[x]'}
            choiceOf: offset
            isSummary: false
          anchor:
            isModifier: false
            short: start | end
            type: code
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: GuidanceResponse.action.relatedAction.anchor}
            isSummary: false
            index: 20
        maxLength: 0
        base: {max: '1', min: 0, path: GuidanceResponse.action.relatedAction}
        required: [actionIdentifier, relationship]
        isSummary: false
      type:
        isModifier: false
        short: create | update | remove | fire-event
        type: code
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: GuidanceResponse.action.type}
        isSummary: false
        index: 23
      behavior:
        isModifier: false
        short: Defines behaviors such as selection and grouping
        index: 24
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          type:
            isModifier: false
            short: The type of behavior (grouping, precheck, selection, cardinality, etc)
            index: 25
            type: Coding
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: GuidanceResponse.action.behavior.type}
            isSummary: false
          value:
            isModifier: false
            short: Specific behavior (e.g. required, at-most-one, single, etc)
            index: 26
            type: Coding
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: GuidanceResponse.action.behavior.value}
            isSummary: false
        maxLength: 0
        base: {max: '*', min: 0, path: GuidanceResponse.action.behavior}
        required: [value, type]
        isSummary: false
      participant:
        isModifier: false
        short: Participant
        index: 22
        type: Reference
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: GuidanceResponse.action.participant}
        isSummary: false
      title:
        isModifier: false
        short: User-visible title
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: GuidanceResponse.action.title}
        isSummary: false
        index: 8
      documentation:
        isModifier: false
        short: Supporting documentation for the intended performer of the action
        index: 21
        type: Attachment
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: GuidanceResponse.action.documentation}
        isSummary: false
      supportingEvidence:
        isModifier: false
        short: Evidence that supports taking the action
        index: 12
        type: Attachment
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: GuidanceResponse.action.supportingEvidence}
        isSummary: false
      label:
        isModifier: false
        short: User-visible label for the action (e.g. 1. or A.)
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: GuidanceResponse.action.label}
        isSummary: false
        index: 7
      resource:
        isModifier: false
        short: The target of the action
        type: Reference
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: GuidanceResponse.action.resource}
        isSummary: false
        index: 27
      concept:
        isModifier: false
        short: The meaning of the action or its sub-actions
        index: 11
        type: CodeableConcept
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: GuidanceResponse.action.concept}
        isSummary: false
      action:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/GuidanceResponse']
        isModifier: false
        short: Sub action
        index: 28
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: GuidanceResponse.action.action}
        isSummary: false
      actionIdentifier:
        isModifier: false
        short: Unique identifier
        type: Identifier
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: GuidanceResponse.action.actionIdentifier}
        isSummary: false
        index: 6
    maxLength: 0
    base: {max: '*', min: 0, path: GuidanceResponse.action}
    isSummary: false
  dataRequirement:
    isModifier: false
    short: Additional required data
    index: 29
    type: DataRequirement
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: GuidanceResponse.dataRequirement}
    isSummary: false
package_version: 1.4.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/GuidanceResponse
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [status, module]