Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

4.18 Resource GuidanceRequest - Content

Clinical Decision Support Work GroupMaturity Level: 0Compartments: Not linked to any defined compartments

A guidance request is a request to evaluate a particular knowledge module focused on decision support, providing information relevant to decision support such as workflow and user context.

4.18.1 Scope and Usage

Todo

4.18.2 Resource Content

UML Diagram

GuidanceRequest (DomainResource)A reference to a knowledge module involved in an interaction (this element modifies the meaning of other elements)module : Reference [1..1] « DecisionSupportRule| DecisionSupportServiceModule »The date and time of the request, with respect to the initiatordateTime : dateTime [0..1]Indicates that the evaluation should be performed as though it was the given date and time. The most direct implication of this is that references to "Now" within the evaluation logic of the module should result in this value. In addition, wherever possible, the data accessed by the module should appear as though it was accessed at this time. The evaluateAtDateTime value may be any time in the past or future, enabling both retrospective and prospective scenarios. If no value is provided, the requestDateTime is assumedevaluateAtDateTime : dateTime [0..1]The input parameters for a request, if any. These parameters are used to provide patient-independent information to the evaluation. Patient-specific information is either accessed directly as part of the evaluation (because the evaluation engine and the patient-data are co-located) or provided as part of the operation input in the form of resourcesinputParameters : Reference [0..1] « Parameters »The organization initiating the requestinitiatingOrganization : Reference [0..1] « Organization »The person initiating the requestinitiatingPerson : Reference [0..1] « Person|Patient|Practitioner| RelatedPerson »The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)userType : CodeableConcept [0..1]Preferred language of the person using the systemuserLanguage : CodeableConcept [0..1] « A human language. (Strength=Required)Language! »The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resourcesuserTaskContext : CodeableConcept [0..1]The organization that will receive the responsereceivingOrganization : Reference [0..1] « Organization »The person in the receiving organization that will receive the responsereceivingPerson : Reference [0..1] « Person|Patient|Practitioner| RelatedPerson »The type of individual that will consume the response content. This may be different from the requesting user type (e.g. if a clinician is getting disease management guidance for provision to a patient). E.g. patient, healthcare provider or specific type of healthcare provider (physician, nurse, etc.)recipientType : CodeableConcept [0..1]Preferred language of the person that will consume the contentrecipientLanguage : CodeableConcept [0..1] « A human language. (Strength=Required)Language! »The class of encounter (inpatient, outpatient, etc)encounterClass : CodeableConcept [0..1] « Classification of the encounter (Strength=Required)EncounterClass! »The type of the encounterencounterType : CodeableConcept [0..1] « The type of encounter (Strength=Example)EncounterType?? »

XML Template

<GuidanceRequest xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <module><!-- 1..1 Reference(DecisionSupportRule|DecisionSupportServiceModule) A reference to a knowledge module --></module>
 <dateTime value="[dateTime]"/><!-- 0..1 The date and time of the request -->
 <evaluateAtDateTime value="[dateTime]"/><!-- 0..1 Indicates that the evaluation should be performed as though it was the given date and time -->
 <inputParameters><!-- 0..1 Reference(Parameters) The input parameters for a request, if any --></inputParameters>
 <initiatingOrganization><!-- 0..1 Reference(Organization)  --></initiatingOrganization>
 <initiatingPerson><!-- 0..1 Reference(Person|Patient|Practitioner|RelatedPerson)  --></initiatingPerson>
 <userType><!-- 0..1 CodeableConcept The type of user initiating the request --></userType>
 <userLanguage><!-- 0..1 CodeableConcept   --></userLanguage>
 <userTaskContext><!-- 0..1 CodeableConcept The task the system user is performing --></userTaskContext>
 <receivingOrganization><!-- 0..1 Reference(Organization)  --></receivingOrganization>
 <receivingPerson><!-- 0..1 Reference(Person|Patient|Practitioner|RelatedPerson)  --></receivingPerson>
 <recipientType><!-- 0..1 CodeableConcept  --></recipientType>
 <recipientLanguage><!-- 0..1 CodeableConcept   --></recipientLanguage>
 <encounterClass><!-- 0..1 CodeableConcept  --></encounterClass>
 <encounterType><!-- 0..1 CodeableConcept  --></encounterType>
</GuidanceRequest>

UML Diagram

GuidanceRequest (DomainResource)A reference to a knowledge module involved in an interaction (this element modifies the meaning of other elements)module : Reference [1..1] « DecisionSupportRule| DecisionSupportServiceModule »The date and time of the request, with respect to the initiatordateTime : dateTime [0..1]Indicates that the evaluation should be performed as though it was the given date and time. The most direct implication of this is that references to "Now" within the evaluation logic of the module should result in this value. In addition, wherever possible, the data accessed by the module should appear as though it was accessed at this time. The evaluateAtDateTime value may be any time in the past or future, enabling both retrospective and prospective scenarios. If no value is provided, the requestDateTime is assumedevaluateAtDateTime : dateTime [0..1]The input parameters for a request, if any. These parameters are used to provide patient-independent information to the evaluation. Patient-specific information is either accessed directly as part of the evaluation (because the evaluation engine and the patient-data are co-located) or provided as part of the operation input in the form of resourcesinputParameters : Reference [0..1] « Parameters »The organization initiating the requestinitiatingOrganization : Reference [0..1] « Organization »The person initiating the requestinitiatingPerson : Reference [0..1] « Person|Patient|Practitioner| RelatedPerson »The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)userType : CodeableConcept [0..1]Preferred language of the person using the systemuserLanguage : CodeableConcept [0..1] « A human language. (Strength=Required)Language! »The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resourcesuserTaskContext : CodeableConcept [0..1]The organization that will receive the responsereceivingOrganization : Reference [0..1] « Organization »The person in the receiving organization that will receive the responsereceivingPerson : Reference [0..1] « Person|Patient|Practitioner| RelatedPerson »The type of individual that will consume the response content. This may be different from the requesting user type (e.g. if a clinician is getting disease management guidance for provision to a patient). E.g. patient, healthcare provider or specific type of healthcare provider (physician, nurse, etc.)recipientType : CodeableConcept [0..1]Preferred language of the person that will consume the contentrecipientLanguage : CodeableConcept [0..1] « A human language. (Strength=Required)Language! »The class of encounter (inpatient, outpatient, etc)encounterClass : CodeableConcept [0..1] « Classification of the encounter (Strength=Required)EncounterClass! »The type of the encounterencounterType : CodeableConcept [0..1] « The type of encounter (Strength=Example)EncounterType?? »

XML Template

<GuidanceRequest xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <module><!-- 1..1 Reference(DecisionSupportRule|DecisionSupportServiceModule) A reference to a knowledge module --></module>
 <dateTime value="[dateTime]"/><!-- 0..1 The date and time of the request -->
 <evaluateAtDateTime value="[dateTime]"/><!-- 0..1 Indicates that the evaluation should be performed as though it was the given date and time -->
 <inputParameters><!-- 0..1 Reference(Parameters) The input parameters for a request, if any --></inputParameters>
 <initiatingOrganization><!-- 0..1 Reference(Organization)  --></initiatingOrganization>
 <initiatingPerson><!-- 0..1 Reference(Person|Patient|Practitioner|RelatedPerson)  --></initiatingPerson>
 <userType><!-- 0..1 CodeableConcept The type of user initiating the request --></userType>
 <userLanguage><!-- 0..1 CodeableConcept   --></userLanguage>
 <userTaskContext><!-- 0..1 CodeableConcept The task the system user is performing --></userTaskContext>
 <receivingOrganization><!-- 0..1 Reference(Organization)  --></receivingOrganization>
 <receivingPerson><!-- 0..1 Reference(Person|Patient|Practitioner|RelatedPerson)  --></receivingPerson>
 <recipientType><!-- 0..1 CodeableConcept  --></recipientType>
 <recipientLanguage><!-- 0..1 CodeableConcept   --></recipientLanguage>
 <encounterClass><!-- 0..1 CodeableConcept  --></encounterClass>
 <encounterType><!-- 0..1 CodeableConcept  --></encounterType>
</GuidanceRequest>

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

4.18.2.1 Terminology Bindings

PathDefinitionTypeReference
GuidanceRequest.userLanguage
GuidanceRequest.recipientLanguage 		A human language.RequiredIETF language tag
GuidanceRequest.encounterClass Classification of the encounterRequiredEncounterClass
GuidanceRequest.encounterType The type of encounterExampleEncounterType