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 
StructureDefinition for guidancerequest
{
"resourceType": "StructureDefinition",
"id": "GuidanceRequest",
"meta": {
"lastUpdated": "2015-12-10T08:57:18.483+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
}
],
"url": "http://hl7.org/fhir/StructureDefinition/GuidanceRequest",
"name": "GuidanceRequest",
"status": "draft",
"publisher": "Health Level Seven International (Clinical Decision Support)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/dss/index.cfm"
}
]
}
],
"date": "2015-12-10T08:57:18+11:00",
"description": "Base StructureDefinition for GuidanceRequest Resource",
"fhirVersion": "1.1.0",
"mapping": [
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"kind": "resource",
"abstract": false,
"base": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"snapshot": {
"element": [
{
"path": "GuidanceRequest",
"short": "A request for decision support guidance",
"definition": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"path": "GuidanceRequest.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"path": "GuidanceRequest.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"path": "GuidanceRequest.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "GuidanceRequest.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "GuidanceRequest.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "GuidanceRequest.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "GuidanceRequest.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "GuidanceRequest.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "GuidanceRequest.module",
"short": "A reference to a knowledge module",
"definition": "A reference to a knowledge module involved in an interaction.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/DecisionSupportRule"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/DecisionSupportServiceModule"
]
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "what"
}
]
},
{
"path": "GuidanceRequest.dateTime",
"short": "The date and time of the request",
"definition": "The date and time of the request, with respect to the initiator.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"path": "GuidanceRequest.evaluateAtDateTime",
"short": "Indicates that the evaluation should be performed as though it was the given date and time",
"definition": "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 assumed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"path": "GuidanceRequest.inputParameters",
"short": "The input parameters for a request, if any",
"definition": "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 resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Parameters"
]
}
]
},
{
"path": "GuidanceRequest.initiatingOrganization",
"definition": "The organization initiating the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"mapping": [
{
"identity": "w5",
"map": "who"
}
]
},
{
"path": "GuidanceRequest.initiatingPerson",
"definition": "The person initiating the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Person"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
],
"mapping": [
{
"identity": "w5",
"map": "who"
}
]
},
{
"path": "GuidanceRequest.userType",
"short": "The type of user initiating the request",
"definition": "The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "GuidanceRequest.userLanguage",
"definition": "Preferred language of the person using the system.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "GuidanceRequest.userTaskContext",
"short": "The task the system user is performing",
"definition": "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 resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "w5",
"map": "why"
}
]
},
{
"path": "GuidanceRequest.receivingOrganization",
"definition": "The organization that will receive the response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
]
},
{
"path": "GuidanceRequest.receivingPerson",
"definition": "The person in the receiving organization that will receive the response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Person"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
]
},
{
"path": "GuidanceRequest.recipientType",
"definition": "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.).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "GuidanceRequest.recipientLanguage",
"definition": "Preferred language of the person that will consume the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "GuidanceRequest.encounterClass",
"definition": "The class of encounter (inpatient, outpatient, etc).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"description": "Classification of the encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/encounter-class"
}
},
"mapping": [
{
"identity": "w5",
"map": "why"
}
]
},
{
"path": "GuidanceRequest.encounterType",
"definition": "The type of the encounter.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "The type of encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/encounter-type"
}
},
"mapping": [
{
"identity": "w5",
"map": "why"
}
]
}
]
},
"differential": {
"element": [
{
"path": "GuidanceRequest",
"short": "A request for decision support guidance",
"definition": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"path": "GuidanceRequest.module",
"short": "A reference to a knowledge module",
"definition": "A reference to a knowledge module involved in an interaction.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/DecisionSupportRule"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/DecisionSupportServiceModule"
]
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "what"
}
]
},
{
"path": "GuidanceRequest.dateTime",
"short": "The date and time of the request",
"definition": "The date and time of the request, with respect to the initiator.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"path": "GuidanceRequest.evaluateAtDateTime",
"short": "Indicates that the evaluation should be performed as though it was the given date and time",
"definition": "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 assumed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"path": "GuidanceRequest.inputParameters",
"short": "The input parameters for a request, if any",
"definition": "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 resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Parameters"
]
}
]
},
{
"path": "GuidanceRequest.initiatingOrganization",
"definition": "The organization initiating the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"mapping": [
{
"identity": "w5",
"map": "who"
}
]
},
{
"path": "GuidanceRequest.initiatingPerson",
"definition": "The person initiating the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Person"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
],
"mapping": [
{
"identity": "w5",
"map": "who"
}
]
},
{
"path": "GuidanceRequest.userType",
"short": "The type of user initiating the request",
"definition": "The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "GuidanceRequest.userLanguage",
"definition": "Preferred language of the person using the system.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "GuidanceRequest.userTaskContext",
"short": "The task the system user is performing",
"definition": "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 resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "w5",
"map": "why"
}
]
},
{
"path": "GuidanceRequest.receivingOrganization",
"definition": "The organization that will receive the response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
]
},
{
"path": "GuidanceRequest.receivingPerson",
"definition": "The person in the receiving organization that will receive the response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Person"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
]
},
{
"path": "GuidanceRequest.recipientType",
"definition": "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.).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "GuidanceRequest.recipientLanguage",
"definition": "Preferred language of the person that will consume the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "GuidanceRequest.encounterClass",
"definition": "The class of encounter (inpatient, outpatient, etc).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"description": "Classification of the encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/encounter-class"
}
},
"mapping": [
{
"identity": "w5",
"map": "why"
}
]
},
{
"path": "GuidanceRequest.encounterType",
"definition": "The type of the encounter.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "The type of encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/encounter-type"
}
},
"mapping": [
{
"identity": "w5",
"map": "why"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU2 (v1.1.0-7408) generated on Thu, Dec 10, 2015 09:00+1100.
Links: Search |
Version History |
Table of Contents |
Compare to DSTU1 |
|
Propose a change