Current Build
Clinical Decision Support Work Group Maturity Level: 1Trial 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:

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse I1..1The formal response to a guidance request
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
Max Binding: All Languages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cqf-cdsHooksEndpoint I1..1uriService endpoint
URL: http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... requestIdentifier Σ1..1IdentifierThe identifier of the request associated with this response, if any
... identifier Σ1..1IdentifierBusiness identifier
... module[x] Σ1..1uri, canonical(), CodeableConceptWhat guidance was requested
... status ?!Σ1..1codesuccess | data-requested | data-required | in-progress | failure | entered-in-error
Binding: GuidanceResponseStatus (required)
... subject S0..1Reference(Patient | Group)Patient the request was performed for
... encounter 0..1Reference(Encounter)Encounter during which the response was returned
... occurrenceDateTime S0..1dateTimeWhen the guidance response was processed
... performer S0..1Reference(Device)Device returning the guidance
... reasonCode 0..*CodeableConceptWhy guidance is needed
... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why guidance is needed
... note 0..*AnnotationAdditional notes about the response
... evaluationMessage 0..*Reference(OperationOutcome)Messages resulting from the evaluation of the artifact or artifacts
... outputParameters 0..1Reference(Parameters)The output parameters of the evaluation, if any
... result S0..1Reference(CarePlan | RequestGroup)Proposed actions, if any
... dataRequirement 0..*DataRequirementAdditional required data

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

<GuidanceResponse xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <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>
 <module[x]><!-- 1..1 uri|canonical|CodeableConcept 
     What guidance was requested --></module[x]>
 <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>
 <reasonCode><!-- 0..* CodeableConcept 
     Why guidance is needed --></reasonCode>
 <reasonReference><!-- 0..* Reference(Condition) 
     Why guidance is needed --></reasonReference>
 <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 }, //Metadata about the resource
    "implicitRules" : "<uri>", //A set of rules under which this content was created
    "language" : "<code>", //Language of the resource content
    "text" : { Narrative }, //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 }], //Extensions that cannot be ignored
    "requestIdentifier" : { Identifier }, // R! The identifier of the request associated with this response, if any
    "identifier" : { Identifier }, // R! Business identifier
// value[x]: What guidance was requested. One of these 3:
    "moduleUri" : "<uri>", // R! What guidance was requested
    "moduleCanonical" : "<canonical>", // R! What guidance was requested
    "moduleCodeableConcept" : { CodeableConcept }, // R! What guidance was requested
    "status" : "<code>", // R! success | data-requested | data-required | in-progress | failure | entered-in-error
    "subject" : { Reference(Patient) }, //Patient the request was performed for
    "encounter" : { Reference(Encounter) }, //Encounter during which the response was returned
    "occurrenceDateTime" : "<dateTime>", //When the guidance response was processed
    "performer" : { Reference(Device) }, //Device returning the guidance
    "reasonCode" : [{ CodeableConcept }], //Why guidance is needed
    "reasonReference" : [{ Reference(Condition) }], //Why guidance is needed
    "note" : [{ Annotation }], //Additional notes about the response
    "evaluationMessage" : [{ Reference(OperationOutcome) }], //Messages resulting from the evaluation of the artifact or artifacts
    "outputParameters" : { Reference(Parameters) }, //The output parameters of the evaluation, if any
    "result" : { Reference(CarePlan) } //Proposed actions, if any
    "dataRequirement" : [{ DataRequirement }], //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

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse I1..1The formal response to a guidance request
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
Max Binding: All Languages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cqf-cdsHooksEndpoint I1..1uriService endpoint
URL: http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... requestIdentifier Σ1..1IdentifierThe identifier of the request associated with this response, if any
... identifier Σ1..1IdentifierBusiness identifier
... module[x] Σ1..1uri, canonical(), CodeableConceptWhat guidance was requested
... status ?!Σ1..1codesuccess | data-requested | data-required | in-progress | failure | entered-in-error
Binding: GuidanceResponseStatus (required)
... subject S0..1Reference(Patient | Group)Patient the request was performed for
... encounter 0..1Reference(Encounter)Encounter during which the response was returned
... occurrenceDateTime S0..1dateTimeWhen the guidance response was processed
... performer S0..1Reference(Device)Device returning the guidance
... reasonCode 0..*CodeableConceptWhy guidance is needed
... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why guidance is needed
... note 0..*AnnotationAdditional notes about the response
... evaluationMessage 0..*Reference(OperationOutcome)Messages resulting from the evaluation of the artifact or artifacts
... outputParameters 0..1Reference(Parameters)The output parameters of the evaluation, if any
... result S0..1Reference(CarePlan | RequestGroup)Proposed actions, if any
... dataRequirement 0..*DataRequirementAdditional required data

doco Documentation for this format

XML Template

<!-- CDS Hooks GuidanceResponse -->doco

<GuidanceResponse xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <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>
 <module[x]><!-- 1..1 uri|canonical|CodeableConcept 
     What guidance was requested --></module[x]>
 <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>
 <reasonCode><!-- 0..* CodeableConcept 
     Why guidance is needed --></reasonCode>
 <reasonReference><!-- 0..* Reference(Condition) 
     Why guidance is needed --></reasonReference>
 <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 }, //Metadata about the resource
    "implicitRules" : "<uri>", //A set of rules under which this content was created
    "language" : "<code>", //Language of the resource content
    "text" : { Narrative }, //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 }], //Extensions that cannot be ignored
    "requestIdentifier" : { Identifier }, // R! The identifier of the request associated with this response, if any
    "identifier" : { Identifier }, // R! Business identifier
// value[x]: What guidance was requested. One of these 3:
    "moduleUri" : "<uri>", // R! What guidance was requested
    "moduleCanonical" : "<canonical>", // R! What guidance was requested
    "moduleCodeableConcept" : { CodeableConcept }, // R! What guidance was requested
    "status" : "<code>", // R! success | data-requested | data-required | in-progress | failure | entered-in-error
    "subject" : { Reference(Patient) }, //Patient the request was performed for
    "encounter" : { Reference(Encounter) }, //Encounter during which the response was returned
    "occurrenceDateTime" : "<dateTime>", //When the guidance response was processed
    "performer" : { Reference(Device) }, //Device returning the guidance
    "reasonCode" : [{ CodeableConcept }], //Why guidance is needed
    "reasonReference" : [{ Reference(Condition) }], //Why guidance is needed
    "note" : [{ Annotation }], //Additional notes about the response
    "evaluationMessage" : [{ Reference(OperationOutcome) }], //Messages resulting from the evaluation of the artifact or artifacts
    "outputParameters" : { Reference(Parameters) }, //The output parameters of the evaluation, if any
    "result" : { Reference(CarePlan) } //Proposed actions, if any
    "dataRequirement" : [{ DataRequirement }], //Additional required data
  }

 

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

PathNameConformanceValueSet
GuidanceResponse.languageCommon LanguagespreferredCommon Languages
GuidanceResponse.statusGuidanceResponseStatusrequiredGuidanceResponseStatus
.