FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

14.16.11.2 StructureDefinition: CDSHooksGuidanceResponse

Clinical Decision Support icon Work Group  Maturity Level: 0 Trial Use Use Context: Any

The canonical URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/cdshooksguidanceresponse

Defines a GuidanceResponse that represents the response container for a CDS Hooks response

This profile was published on Thu, Jan 1, 1970 00:00+0000 as a draft by HL7.

14.16.11.2.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from GuidanceResponse.

Summary

Mandatory: 4 elements
Must-Support: 4 elements

Extensions

This structure refers to these extensions:

This indicates the differences between this profile and the base GuidanceResponse structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. GuidanceResponse 1..1 GuidanceResponse The formal response to a guidance request
... Slices for extension Content/Rules for all slices
.... cdsHooksEndpoint 1..1 uri Service endpoint
URL: http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint
... requestIdentifier 1..1 Identifier The identifier of the request associated with this response, if any
... identifier 1..1 Identifier Business identifier
... moduleUri 1..1 uri What guidance was requested
... subject S 0..1 Reference(Patient | Group) Patient the request was performed for
... occurrenceDateTime S 0..1 dateTime When the guidance response was processed
... performer S 0..1 Reference(Device) Device returning the guidance
... result S 0..* Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | Task | VisionPrescription) Proposed actions, if any

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base GuidanceResponse structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. GuidanceResponse 1..1 GuidanceResponse The formal response to a guidance request
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common Languages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... cdsHooksEndpoint 1..1 uri Service endpoint
URL: http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... requestIdentifier Σ 1..1 Identifier The identifier of the request associated with this response, if any
... identifier Σ 1..1 Identifier Business identifier
... Slices for module[x] Σ 1..1 uri What guidance was requested
Slice: Unordered, Closed by type:$this
Binding: Guidance Module Code (example)
.... module[x]:moduleUri Σ 1..1 uri What guidance was requested
Binding: Guidance Module Code (example)
... status ?!Σ 1..1 code success | data-requested | data-required | in-progress | failure | entered-in-error
Binding: Guidance Response Status (required): The status of a guidance response.

... subject S 0..1 Reference(Patient | Group) Patient the request was performed for
... encounter 0..1 Reference(Encounter) Encounter during which the response was returned
... occurrenceDateTime S 0..1 dateTime When the guidance response was processed
... performer S 0..1 Reference(Device) Device returning the guidance
... reason 0..* CodeableReference() Why guidance is needed
... note 0..* Annotation Additional notes about the response
... evaluationMessage 0..1 Reference(OperationOutcome) Messages resulting from the evaluation of the artifact or artifacts
... outputParameters 0..1 Reference(Parameters) The output parameters of the evaluation, if any
... result S 0..* Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | Task | VisionPrescription) Proposed actions, if any
... dataRequirement 0..* DataRequirement Additional required data

doco Documentation for this format icon
<!-- CDSHooksGuidanceResponse -->doco

<GuidanceResponse xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource 
     Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <requestIdentifier><!-- I 1..1 Identifier 
     The identifier of the request associated with this response, if any --></requestIdentifier>
 <identifier><!-- I 1..1 Identifier Business identifier --></identifier>
 <-- moduleUri sliced by type:$this  in the specified orderClosed-->
 <moduleUri value="[uri]"/><!-- I 1..1 What guidance was requested   -->
 <status value="[code]"/><!-- I 1..1 success | data-requested | data-required | in-progress | failure | entered-in-error   -->
 <subject><!-- I 0..1 Reference(Patient) 
     Patient the request was performed for --></subject>
 <encounter><!-- I 0..1 Reference(Encounter) 
     Encounter during which the response was returned --></encounter>
 <occurrenceDateTime value="[dateTime]"/><!-- I 0..1 When the guidance response was processed -->
 <performer><!-- I 0..1 Reference(Device) 
     Device returning the guidance --></performer>
 <reason><!-- I 0..* CodeableReference 
     Why guidance is needed --></reason>
 <note><!-- I 0..* Annotation 
     Additional notes about the response --></note>
 <evaluationMessage><!-- I 0..1 Reference(OperationOutcome) 
     Messages resulting from the evaluation of the artifact or artifacts --></evaluationMessage>
 <outputParameters><!-- I 0..1 Reference(Parameters) 
     The output parameters of the evaluation, if any --></outputParameters>
 <result><!-- I 0..* Reference(Appointment) Proposed actions, if any --></result>
 <dataRequirement><!-- I 0..* DataRequirement 
     Additional required data --></dataRequirement>
</GuidanceResponse>

{ // CDSHooksGuidanceResponse
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Service endpoint // I R! 
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "requestIdentifier" : { Identifier }, // I R! The identifier of the request associated with this response, if any
    "identifier" : { Identifier }, // I R! Business identifier
    "moduleUri" : [ //  sliced by type:$this  in the specified order, Closed 
      { // What guidance was requested // I R! 
        // from Element: extension
      }
    ],
    "status" : "<code>", // I R! success | data-requested | data-required | in-progress | failure | entered-in-error
    "subject" : { Reference(Patient) }, // IPatient the request was performed for
    "encounter" : { Reference(Encounter) }, // IEncounter during which the response was returned
    "occurrenceDateTime" : "<dateTime>", // IWhen the guidance response was processed
    "performer" : { Reference(Device) }, // IDevice returning the guidance
    "reason" : [{ CodeableReference }], // IWhy guidance is needed
    "note" : [{ Annotation }], // IAdditional notes about the response
    "evaluationMessage" : { Reference(OperationOutcome) }, // IMessages resulting from the evaluation of the artifact or artifacts
    "outputParameters" : { Reference(Parameters) }, // IThe output parameters of the evaluation, if any
    "result" : [{ Reference(Appointment) }], // IProposed actions, if any
    "dataRequirement" : [{ DataRequirement }], // IAdditional required data
  }

This structure is derived from GuidanceResponse.

Summary

Mandatory: 4 elements
Must-Support: 4 elements

Extensions

This structure refers to these extensions:

Differential View

This indicates the differences between this profile and the base GuidanceResponse structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. GuidanceResponse 1..1 GuidanceResponse The formal response to a guidance request
... Slices for extension Content/Rules for all slices
.... cdsHooksEndpoint 1..1 uri Service endpoint
URL: http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint
... requestIdentifier 1..1 Identifier The identifier of the request associated with this response, if any
... identifier 1..1 Identifier Business identifier
... moduleUri 1..1 uri What guidance was requested
... subject S 0..1 Reference(Patient | Group) Patient the request was performed for
... occurrenceDateTime S 0..1 dateTime When the guidance response was processed
... performer S 0..1 Reference(Device) Device returning the guidance
... result S 0..* Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | Task | VisionPrescription) Proposed actions, if any

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base GuidanceResponse structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. GuidanceResponse 1..1 GuidanceResponse The formal response to a guidance request
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common Languages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... cdsHooksEndpoint 1..1 uri Service endpoint
URL: http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... requestIdentifier Σ 1..1 Identifier The identifier of the request associated with this response, if any
... identifier Σ 1..1 Identifier Business identifier
... Slices for module[x] Σ 1..1 uri What guidance was requested
Slice: Unordered, Closed by type:$this
Binding: Guidance Module Code (example)
.... module[x]:moduleUri Σ 1..1 uri What guidance was requested
Binding: Guidance Module Code (example)
... status ?!Σ 1..1 code success | data-requested | data-required | in-progress | failure | entered-in-error
Binding: Guidance Response Status (required): The status of a guidance response.

... subject S 0..1 Reference(Patient | Group) Patient the request was performed for
... encounter 0..1 Reference(Encounter) Encounter during which the response was returned
... occurrenceDateTime S 0..1 dateTime When the guidance response was processed
... performer S 0..1 Reference(Device) Device returning the guidance
... reason 0..* CodeableReference() Why guidance is needed
... note 0..* Annotation Additional notes about the response
... evaluationMessage 0..1 Reference(OperationOutcome) Messages resulting from the evaluation of the artifact or artifacts
... outputParameters 0..1 Reference(Parameters) The output parameters of the evaluation, if any
... result S 0..* Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | Task | VisionPrescription) Proposed actions, if any
... dataRequirement 0..* DataRequirement Additional required data

doco Documentation for this format icon

XML Template

<!-- CDSHooksGuidanceResponse -->doco

<GuidanceResponse xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource 
     Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <requestIdentifier><!-- I 1..1 Identifier 
     The identifier of the request associated with this response, if any --></requestIdentifier>
 <identifier><!-- I 1..1 Identifier Business identifier --></identifier>
 <-- moduleUri sliced by type:$this  in the specified orderClosed-->
 <moduleUri value="[uri]"/><!-- I 1..1 What guidance was requested   -->
 <status value="[code]"/><!-- I 1..1 success | data-requested | data-required | in-progress | failure | entered-in-error   -->
 <subject><!-- I 0..1 Reference(Patient) 
     Patient the request was performed for --></subject>
 <encounter><!-- I 0..1 Reference(Encounter) 
     Encounter during which the response was returned --></encounter>
 <occurrenceDateTime value="[dateTime]"/><!-- I 0..1 When the guidance response was processed -->
 <performer><!-- I 0..1 Reference(Device) 
     Device returning the guidance --></performer>
 <reason><!-- I 0..* CodeableReference 
     Why guidance is needed --></reason>
 <note><!-- I 0..* Annotation 
     Additional notes about the response --></note>
 <evaluationMessage><!-- I 0..1 Reference(OperationOutcome) 
     Messages resulting from the evaluation of the artifact or artifacts --></evaluationMessage>
 <outputParameters><!-- I 0..1 Reference(Parameters) 
     The output parameters of the evaluation, if any --></outputParameters>
 <result><!-- I 0..* Reference(Appointment) Proposed actions, if any --></result>
 <dataRequirement><!-- I 0..* DataRequirement 
     Additional required data --></dataRequirement>
</GuidanceResponse>

JSON Template

{ // CDSHooksGuidanceResponse
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Service endpoint // I R! 
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "requestIdentifier" : { Identifier }, // I R! The identifier of the request associated with this response, if any
    "identifier" : { Identifier }, // I R! Business identifier
    "moduleUri" : [ //  sliced by type:$this  in the specified order, Closed 
      { // What guidance was requested // I R! 
        // from Element: extension
      }
    ],
    "status" : "<code>", // I R! success | data-requested | data-required | in-progress | failure | entered-in-error
    "subject" : { Reference(Patient) }, // IPatient the request was performed for
    "encounter" : { Reference(Encounter) }, // IEncounter during which the response was returned
    "occurrenceDateTime" : "<dateTime>", // IWhen the guidance response was processed
    "performer" : { Reference(Device) }, // IDevice returning the guidance
    "reason" : [{ CodeableReference }], // IWhy guidance is needed
    "note" : [{ Annotation }], // IAdditional notes about the response
    "evaluationMessage" : { Reference(OperationOutcome) }, // IMessages resulting from the evaluation of the artifact or artifacts
    "outputParameters" : { Reference(Parameters) }, // IThe output parameters of the evaluation, if any
    "result" : [{ Reference(Appointment) }], // IProposed actions, if any
    "dataRequirement" : [{ DataRequirement }], // IAdditional required data
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

14.16.11.2.2 Terminology Bindings

Path Name Conformance ValueSet
GuidanceResponse.language All Languages required All Languages
GuidanceResponse.module[x] Guidance Module Code example Guidance Module Code
GuidanceResponse.module[x] Guidance Module Code example Guidance Module Code
GuidanceResponse.status Guidance Response Status required Guidance Response Status
. .