Release 4 5 Preview #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v4.2.0: R5 Preview #1). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

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

The official 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 [no date] as a draft by HL7.

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:

Name Flags Card. Type Description & Constraints doco
. . GuidanceResponse I 1..1 GuidanceResponse The formal response to a guidance request
. . . id Σ 0..1 string id Logical id of this artifact
. . . meta Σ I 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ I 0..1 uri A set of rules under which this content was created
. . . text I 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension I 0..* Extension Extension
Slice: Unordered, Open by value:url
. . . cqf-cdsHooksEndpoint I 1..1 uri Service endpoint
URL: http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint
. . . modifierExtension ?! I 0..* Extension Extensions that cannot be ignored
. . . requestIdentifier Σ I 1..1 Identifier The identifier of the request associated with this response, if any
. . . identifier Σ I 1..1 Identifier Business identifier
. . . module[x] Σ I 1 .. 1 (Slice Definition) What guidance was requested
Slice: Unordered, Closed by type:$this
. . . . module[x]:moduleUri Σ I 1..1 uri What guidance was requested
. . . status ?! Σ I 1..1 code success | data-requested | data-required | in-progress | failure | entered-in-error
Binding: GuidanceResponseStatus ( required )
. . . subject S I 0..1 Reference ( Patient | Group ) Patient the request was performed for
. . . encounter I 0..1 Reference ( Encounter ) Encounter during which the response was returned
. . . occurrenceDateTime S I 0..1 dateTime When the guidance response was processed
. . . performer S I 0..1 Reference ( Device ) Device returning the guidance
. . reasonCode . reason I 0..* CodeableConcept Why guidance is needed reasonReference I 0..* Reference CodeableReference ( Condition | Observation | DiagnosticReport | DocumentReference ) Why guidance is needed
. . . note I 0..* Annotation Additional notes about the response
. . . evaluationMessage I 0..* Reference ( OperationOutcome ) Messages resulting from the evaluation of the artifact or artifacts
. . . outputParameters I 0..1 Reference ( Parameters ) The output parameters of the evaluation, if any
. . . result S I 0..1 Reference ( CarePlan | RequestGroup ) Proposed actions, if any
. . . dataRequirement I 0..* DataRequirement Additional required data

doco Documentation for this format
<!-- CDS Hooks GuidanceResponse -->doco

<GuidanceResponse xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->

 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource 
     Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <requestIdentifier><!-- ?? 1..1 Identifier 
     The identifier of the request associated with this response, if any --></requestIdentifier>
 <identifier><!-- ?? 1..1 Identifier Business identifier --></identifier>
 <-- moduleUri sliced by type:$this  in the specified orderClosed-->
 <moduleUri value="[uri]"/><!-- ?? 1..1 What guidance was requested -->
 <status value="[code]"/><!-- ?? 1..1 success | data-requested | data-required | in-progress | failure | entered-in-error   -->
 <subject><!-- ?? 0..1 Reference(Patient) 
     Patient the request was performed for --></subject>
 <encounter><!-- ?? 0..1 Reference(Encounter) 
     Encounter during which the response was returned --></encounter>
 <occurrenceDateTime value="[dateTime]"/><!-- ?? 0..1 When the guidance response was processed -->
 <performer><!-- ?? 0..1 Reference(Device) 
     Device returning the guidance --></performer>
 <
     Why guidance is needed</reasonCode>
 <
     Why guidance is needed</reasonReference>

 <reason><!-- ?? 0..* CodeableReference 
     Why guidance is needed --></reason>

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

    "reason" : [{ CodeableReference(Condition) }], // C?Why guidance is needed

    "note" : [{ Annotation }], // C?Additional notes about the response
    "evaluationMessage" : [{ Reference(OperationOutcome) }], // C?Messages resulting from the evaluation of the artifact or artifacts
    "outputParameters" : { Reference(Parameters) }, // C?The output parameters of the evaluation, if any
    "result" : { Reference(CarePlan) }, // C?Proposed actions, if any
    "dataRequirement" : [{ DataRequirement }], // C?Additional required data
  }

This structure is derived from GuidanceResponse .

Summary

Mandatory: 4 elements
Must-Support: 4 elements

Extensions

This structure refers to these extensions:

Snapshot View

Name Flags Card. Type Description & Constraints doco
. . GuidanceResponse I 1..1 GuidanceResponse The formal response to a guidance request
. . . id Σ 0..1 string id Logical id of this artifact
. . . meta Σ I 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ I 0..1 uri A set of rules under which this content was created
. . . text I 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension I 0..* Extension Extension
Slice: Unordered, Open by value:url
. . . cqf-cdsHooksEndpoint I 1..1 uri Service endpoint
URL: http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint
. . . modifierExtension ?! I 0..* Extension Extensions that cannot be ignored
. . . requestIdentifier Σ I 1..1 Identifier The identifier of the request associated with this response, if any
. . . identifier Σ I 1..1 Identifier Business identifier
. . . module[x] Σ I 1 .. 1 (Slice Definition) What guidance was requested
Slice: Unordered, Closed by type:$this
. . . . module[x]:moduleUri Σ I 1..1 uri What guidance was requested
. . . status ?! Σ I 1..1 code success | data-requested | data-required | in-progress | failure | entered-in-error
Binding: GuidanceResponseStatus ( required )
. . . subject S I 0..1 Reference ( Patient | Group ) Patient the request was performed for
. . . encounter I 0..1 Reference ( Encounter ) Encounter during which the response was returned
. . . occurrenceDateTime S I 0..1 dateTime When the guidance response was processed
. . . performer S I 0..1 Reference ( Device ) Device returning the guidance
. . reasonCode . reason I 0..* CodeableConcept Why guidance is needed reasonReference I 0..* Reference CodeableReference ( Condition | Observation | DiagnosticReport | DocumentReference ) Why guidance is needed
. . . note I 0..* Annotation Additional notes about the response
. . . evaluationMessage I 0..* Reference ( OperationOutcome ) Messages resulting from the evaluation of the artifact or artifacts
. . . outputParameters I 0..1 Reference ( Parameters ) The output parameters of the evaluation, if any
. . . result S I 0..1 Reference ( CarePlan | RequestGroup ) Proposed actions, if any
. . . dataRequirement I 0..* DataRequirement Additional required data

doco Documentation for this format

XML Template

<!-- CDS Hooks GuidanceResponse -->doco

<GuidanceResponse xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <</id>

 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->

 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource 
     Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <requestIdentifier><!-- ?? 1..1 Identifier 
     The identifier of the request associated with this response, if any --></requestIdentifier>
 <identifier><!-- ?? 1..1 Identifier Business identifier --></identifier>
 <-- moduleUri sliced by type:$this  in the specified orderClosed-->
 <moduleUri value="[uri]"/><!-- ?? 1..1 What guidance was requested -->
 <status value="[code]"/><!-- ?? 1..1 success | data-requested | data-required | in-progress | failure | entered-in-error   -->
 <subject><!-- ?? 0..1 Reference(Patient) 
     Patient the request was performed for --></subject>
 <encounter><!-- ?? 0..1 Reference(Encounter) 
     Encounter during which the response was returned --></encounter>
 <occurrenceDateTime value="[dateTime]"/><!-- ?? 0..1 When the guidance response was processed -->
 <performer><!-- ?? 0..1 Reference(Device) 
     Device returning the guidance --></performer>
 <
     Why guidance is needed</reasonCode>
 <
     Why guidance is needed</reasonReference>

 <reason><!-- ?? 0..* CodeableReference 
     Why guidance is needed --></reason>

 <note><!-- ?? 0..* Annotation 
     Additional notes about the response --></note>
 <evaluationMessage><!-- ?? 0..* Reference(OperationOutcome) 
     Messages resulting from the evaluation of the artifact or artifacts --></evaluationMessage>
 <outputParameters><!-- ?? 0..1 Reference(Parameters) 
     The output parameters of the evaluation, if any --></outputParameters>
 <result><!-- ?? 0..1 Reference(CarePlan) Proposed actions, if any --></result>
 <dataRequirement><!-- ?? 0..* DataRequirement 
     Additional required data --></dataRequirement>
</GuidanceResponse>

JSON Template

{ // CDS Hooks GuidanceResponse
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Service endpoint // C? R! 
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "requestIdentifier" : { Identifier }, // C? R! The identifier of the request associated with this response, if any
    "identifier" : { Identifier }, // C? R! Business identifier
    "moduleUri" : [ //  sliced by type:$this  in the specified order, Closed 
      { // What guidance was requested // C? R! 
        // from Element: extension
      }
    ],
    "status" : "<code>", // C? R! success | data-requested | data-required | in-progress | failure | entered-in-error
    "subject" : { Reference(Patient) }, // C?Patient the request was performed for
    "encounter" : { Reference(Encounter) }, // C?Encounter during which the response was returned
    "occurrenceDateTime" : "<dateTime>", // C?When the guidance response was processed
    "performer" : { Reference(Device) }, // C?Device returning the guidance
    "
    "

    "reason" : [{ CodeableReference(Condition) }], // C?Why guidance is needed

    "note" : [{ Annotation }], // C?Additional notes about the response
    "evaluationMessage" : [{ Reference(OperationOutcome) }], // C?Messages resulting from the evaluation of the artifact or artifacts
    "outputParameters" : { Reference(Parameters) }, // C?The output parameters of the evaluation, if any
    "result" : { Reference(CarePlan) }, // C?Proposed actions, if any
    "dataRequirement" : [{ DataRequirement }], // C?Additional required data
  }

 

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

Path Name Conformance ValueSet
GuidanceResponse.language Common Languages preferred Common Languages
GuidanceResponse.status GuidanceResponseStatus required GuidanceResponseStatus
.