STU 3 Ballot
Clinical ReasoningThis page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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 R3
StructureDefinition for guidanceresponse
{
"resourceType": "StructureDefinition",
"id": "GuidanceResponse",
"meta": {
"lastUpdated": "2016-08-11T17:02:54.322+10: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/GuidanceResponse",
"name": "GuidanceResponse",
"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": "2016-08-11T17:02:54+10:00",
"description": "Base StructureDefinition for GuidanceResponse Resource",
"fhirVersion": "1.6.0",
"mapping": [
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "GuidanceResponse",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "GuidanceResponse",
"path": "GuidanceResponse",
"short": "The formal response to a guidance request",
"definition": "A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"id": "GuidanceResponse.id",
"path": "GuidanceResponse.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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "GuidanceResponse.meta",
"path": "GuidanceResponse.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",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "GuidanceResponse.implicitRules",
"path": "GuidanceResponse.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",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "GuidanceResponse.language",
"path": "GuidanceResponse.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",
"base": {
"path": "Resource.language",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "GuidanceResponse.text",
"path": "GuidanceResponse.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. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "GuidanceResponse.contained",
"path": "GuidanceResponse.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": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "GuidanceResponse.extension",
"path": "GuidanceResponse.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": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "GuidanceResponse.modifierExtension",
"path": "GuidanceResponse.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": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "GuidanceResponse.requestId",
"path": "GuidanceResponse.requestId",
"short": "The id of the request associated with this response, if any",
"definition": "The id of the request associated with this response. If an id was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"id": "GuidanceResponse.identifier",
"path": "GuidanceResponse.identifier",
"short": "Business identifier",
"definition": "Allows a service to provide a unique, business identifier for the response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "GuidanceResponse.module",
"path": "GuidanceResponse.module",
"short": "A reference to a knowledge module",
"definition": "A reference to the knowledge module that was invoked.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DecisionSupportServiceModule"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "GuidanceResponse.status",
"path": "GuidanceResponse.status",
"short": "success | data-requested | data-required | in-progress | failure",
"definition": "The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The status of a guidance response",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/guidance-response-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "GuidanceResponse.subject",
"path": "GuidanceResponse.subject",
"short": "Patient the request was performed for",
"definition": "The patient for which the request was processed.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"mapping": [
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "GuidanceResponse.context",
"path": "GuidanceResponse.context",
"short": "Encounter or Episode during which the response was returned",
"definition": "Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"mapping": [
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "GuidanceResponse.occurrenceDateTime",
"path": "GuidanceResponse.occurrenceDateTime",
"short": "When the guidance response was processed",
"definition": "Indicates when the guidance response was processed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "GuidanceResponse.performer",
"path": "GuidanceResponse.performer",
"short": "Device returning the guidance",
"definition": "Provides a reference to the device that performed the guidance.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "GuidanceResponse.reason[x]",
"path": "GuidanceResponse.reason[x]",
"short": "Reason for the response",
"definition": "Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "GuidanceResponse.note",
"path": "GuidanceResponse.note",
"short": "Additional notes about the response",
"definition": "Provides a mechanism to communicate additional information about the response.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
]
},
{
"id": "GuidanceResponse.evaluationMessage",
"path": "GuidanceResponse.evaluationMessage",
"short": "Messages resulting from the evaluation of the artifact or artifacts",
"definition": "Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/OperationOutcome"
}
]
},
{
"id": "GuidanceResponse.outputParameters",
"path": "GuidanceResponse.outputParameters",
"short": "The output parameters of the evaluation, if any",
"definition": "The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Parameters"
}
]
},
{
"id": "GuidanceResponse.action",
"path": "GuidanceResponse.action",
"short": "Proposed actions, if any",
"definition": "The actions, if any, produced by the evaluation of the artifact.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "GuidanceResponse.action.id",
"path": "GuidanceResponse.action.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "GuidanceResponse.action.extension",
"path": "GuidanceResponse.action.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 element. 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": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "GuidanceResponse.action.modifierExtension",
"path": "GuidanceResponse.action.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 element, 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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "GuidanceResponse.action.actionIdentifier",
"path": "GuidanceResponse.action.actionIdentifier",
"short": "Unique identifier",
"definition": "A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "GuidanceResponse.action.label",
"path": "GuidanceResponse.action.label",
"short": "User-visible label for the action (e.g. 1. or A.)",
"definition": "A user-visible label for the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "GuidanceResponse.action.title",
"path": "GuidanceResponse.action.title",
"short": "User-visible title",
"definition": "The title of the action displayed to a user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "GuidanceResponse.action.description",
"path": "GuidanceResponse.action.description",
"short": "Short description of the action",
"definition": "A short description of the action used to provide a summary to display to the user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "GuidanceResponse.action.textEquivalent",
"path": "GuidanceResponse.action.textEquivalent",
"short": "Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system",
"definition": "A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that may not be capable of interpreting it dynamically.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "GuidanceResponse.action.concept",
"path": "GuidanceResponse.action.concept",
"short": "The meaning of the action or its sub-actions",
"definition": "The concept represented by this action or its sub-actions.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "GuidanceResponse.action.documentation",
"path": "GuidanceResponse.action.documentation",
"short": "Supporting documentation for the intended performer of the action",
"definition": "Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.",
"min": 0,
"max": "*",
"type": [
{
"code": "RelatedResource"
}
]
},
{
"id": "GuidanceResponse.action.relatedAction",
"path": "GuidanceResponse.action.relatedAction",
"short": "Relationship to another action",
"definition": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "GuidanceResponse.action.relatedAction.id",
"path": "GuidanceResponse.action.relatedAction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "GuidanceResponse.action.relatedAction.extension",
"path": "GuidanceResponse.action.relatedAction.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 element. 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": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "GuidanceResponse.action.relatedAction.modifierExtension",
"path": "GuidanceResponse.action.relatedAction.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 element, 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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "GuidanceResponse.action.relatedAction.actionIdentifier",
"path": "GuidanceResponse.action.relatedAction.actionIdentifier",
"short": "Identifier of the related action",
"definition": "The unique identifier of the related action.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "GuidanceResponse.action.relatedAction.relationship",
"path": "GuidanceResponse.action.relatedAction.relationship",
"short": "before | after",
"definition": "The relationship of this action to the related action.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines the types of relationships between actions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-relationship-type"
}
}
},
{
"id": "GuidanceResponse.action.relatedAction.offset[x]",
"path": "GuidanceResponse.action.relatedAction.offset[x]",
"short": "Time offset for the relationship",
"definition": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
},
{
"code": "Range"
}
]
},
{
"id": "GuidanceResponse.action.relatedAction.anchor",
"path": "GuidanceResponse.action.relatedAction.anchor",
"short": "start | end",
"definition": "An optional indicator for how the relationship is anchored to the related action. For example \"before the start\" or \"before the end\" of the related action.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines possible anchors for the relationship between actions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-relationship-anchor"
}
}
},
{
"id": "GuidanceResponse.action.timing[x]",
"path": "GuidanceResponse.action.timing[x]",
"short": "When the action should take place",
"definition": "An optional value describing when the action should be performed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Duration"
},
{
"code": "Range"
}
]
},
{
"id": "GuidanceResponse.action.participant",
"path": "GuidanceResponse.action.participant",
"short": "Participant",
"definition": "The participant in the action.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Person"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
},
{
"id": "GuidanceResponse.action.type",
"path": "GuidanceResponse.action.type",
"short": "create | update | remove | fire-event",
"definition": "The type of action to perform (create, update, remove).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "The type of action to be performed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-type"
}
}
},
{
"id": "GuidanceResponse.action.groupingBehavior",
"path": "GuidanceResponse.action.groupingBehavior",
"short": "visual-group | logical-group | sentence-group",
"definition": "Defines the grouping behavior for the action and its children.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines organization behavior of a group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-grouping-behavior"
}
}
},
{
"id": "GuidanceResponse.action.selectionBehavior",
"path": "GuidanceResponse.action.selectionBehavior",
"short": "any | all | all-or-none | exactly-one | at-most-one | one-or-more",
"definition": "Defines the selection behavior for the action and its children.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines selection behavior of a group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-selection-behavior"
}
}
},
{
"id": "GuidanceResponse.action.requiredBehavior",
"path": "GuidanceResponse.action.requiredBehavior",
"short": "must | could | must-unless-documented",
"definition": "Defines the requiredness behavior for the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines requiredness behavior for selecting an action or an action group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-required-behavior"
}
}
},
{
"id": "GuidanceResponse.action.precheckBehavior",
"path": "GuidanceResponse.action.precheckBehavior",
"short": "yes | no",
"definition": "Defines whether the action should usually be preselected.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines selection frequency behavior for an action or group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-precheck-behavior"
}
}
},
{
"id": "GuidanceResponse.action.cardinalityBehavior",
"path": "GuidanceResponse.action.cardinalityBehavior",
"short": "single | multiple",
"definition": "Defines whether the action can be selected multiple times.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines behavior for an action or a group for how many times that item may be repeated",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-cardinality-behavior"
}
}
},
{
"id": "GuidanceResponse.action.resource",
"path": "GuidanceResponse.action.resource",
"short": "The target of the action",
"definition": "The resource that is the target of the action (e.g. CommunicationRequest).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"id": "GuidanceResponse.action.action",
"path": "GuidanceResponse.action.action",
"short": "Sub action",
"definition": "Sub actions.",
"min": 0,
"max": "*",
"contentReference": "#GuidanceResponse.action"
},
{
"id": "GuidanceResponse.dataRequirement",
"path": "GuidanceResponse.dataRequirement",
"short": "Additional required data",
"definition": "If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.",
"min": 0,
"max": "*",
"type": [
{
"code": "DataRequirement"
}
]
}
]
},
"differential": {
"element": [
{
"id": "GuidanceResponse",
"path": "GuidanceResponse",
"short": "The formal response to a guidance request",
"definition": "A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"id": "GuidanceResponse.requestId",
"path": "GuidanceResponse.requestId",
"short": "The id of the request associated with this response, if any",
"definition": "The id of the request associated with this response. If an id was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"id": "GuidanceResponse.identifier",
"path": "GuidanceResponse.identifier",
"short": "Business identifier",
"definition": "Allows a service to provide a unique, business identifier for the response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "GuidanceResponse.module",
"path": "GuidanceResponse.module",
"short": "A reference to a knowledge module",
"definition": "A reference to the knowledge module that was invoked.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DecisionSupportServiceModule"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "GuidanceResponse.status",
"path": "GuidanceResponse.status",
"short": "success | data-requested | data-required | in-progress | failure",
"definition": "The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The status of a guidance response",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/guidance-response-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "GuidanceResponse.subject",
"path": "GuidanceResponse.subject",
"short": "Patient the request was performed for",
"definition": "The patient for which the request was processed.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"mapping": [
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "GuidanceResponse.context",
"path": "GuidanceResponse.context",
"short": "Encounter or Episode during which the response was returned",
"definition": "Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"mapping": [
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "GuidanceResponse.occurrenceDateTime",
"path": "GuidanceResponse.occurrenceDateTime",
"short": "When the guidance response was processed",
"definition": "Indicates when the guidance response was processed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "GuidanceResponse.performer",
"path": "GuidanceResponse.performer",
"short": "Device returning the guidance",
"definition": "Provides a reference to the device that performed the guidance.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "GuidanceResponse.reason[x]",
"path": "GuidanceResponse.reason[x]",
"short": "Reason for the response",
"definition": "Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "GuidanceResponse.note",
"path": "GuidanceResponse.note",
"short": "Additional notes about the response",
"definition": "Provides a mechanism to communicate additional information about the response.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
]
},
{
"id": "GuidanceResponse.evaluationMessage",
"path": "GuidanceResponse.evaluationMessage",
"short": "Messages resulting from the evaluation of the artifact or artifacts",
"definition": "Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/OperationOutcome"
}
]
},
{
"id": "GuidanceResponse.outputParameters",
"path": "GuidanceResponse.outputParameters",
"short": "The output parameters of the evaluation, if any",
"definition": "The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Parameters"
}
]
},
{
"id": "GuidanceResponse.action",
"path": "GuidanceResponse.action",
"short": "Proposed actions, if any",
"definition": "The actions, if any, produced by the evaluation of the artifact.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "GuidanceResponse.action.actionIdentifier",
"path": "GuidanceResponse.action.actionIdentifier",
"short": "Unique identifier",
"definition": "A unique identifier for the action. The identifier SHALL be unique within the container in which it appears, and MAY be universally unique.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "GuidanceResponse.action.label",
"path": "GuidanceResponse.action.label",
"short": "User-visible label for the action (e.g. 1. or A.)",
"definition": "A user-visible label for the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "GuidanceResponse.action.title",
"path": "GuidanceResponse.action.title",
"short": "User-visible title",
"definition": "The title of the action displayed to a user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "GuidanceResponse.action.description",
"path": "GuidanceResponse.action.description",
"short": "Short description of the action",
"definition": "A short description of the action used to provide a summary to display to the user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "GuidanceResponse.action.textEquivalent",
"path": "GuidanceResponse.action.textEquivalent",
"short": "Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system",
"definition": "A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that may not be capable of interpreting it dynamically.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "GuidanceResponse.action.concept",
"path": "GuidanceResponse.action.concept",
"short": "The meaning of the action or its sub-actions",
"definition": "The concept represented by this action or its sub-actions.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "GuidanceResponse.action.documentation",
"path": "GuidanceResponse.action.documentation",
"short": "Supporting documentation for the intended performer of the action",
"definition": "Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.",
"min": 0,
"max": "*",
"type": [
{
"code": "RelatedResource"
}
]
},
{
"id": "GuidanceResponse.action.relatedAction",
"path": "GuidanceResponse.action.relatedAction",
"short": "Relationship to another action",
"definition": "A relationship to another action such as \"before\" or \"30-60 minutes after start of\".",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "GuidanceResponse.action.relatedAction.actionIdentifier",
"path": "GuidanceResponse.action.relatedAction.actionIdentifier",
"short": "Identifier of the related action",
"definition": "The unique identifier of the related action.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "GuidanceResponse.action.relatedAction.relationship",
"path": "GuidanceResponse.action.relatedAction.relationship",
"short": "before | after",
"definition": "The relationship of this action to the related action.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines the types of relationships between actions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-relationship-type"
}
}
},
{
"id": "GuidanceResponse.action.relatedAction.offset[x]",
"path": "GuidanceResponse.action.relatedAction.offset[x]",
"short": "Time offset for the relationship",
"definition": "A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
},
{
"code": "Range"
}
]
},
{
"id": "GuidanceResponse.action.relatedAction.anchor",
"path": "GuidanceResponse.action.relatedAction.anchor",
"short": "start | end",
"definition": "An optional indicator for how the relationship is anchored to the related action. For example \"before the start\" or \"before the end\" of the related action.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines possible anchors for the relationship between actions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-relationship-anchor"
}
}
},
{
"id": "GuidanceResponse.action.timing[x]",
"path": "GuidanceResponse.action.timing[x]",
"short": "When the action should take place",
"definition": "An optional value describing when the action should be performed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Duration"
},
{
"code": "Range"
}
]
},
{
"id": "GuidanceResponse.action.participant",
"path": "GuidanceResponse.action.participant",
"short": "Participant",
"definition": "The participant in the action.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Person"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
},
{
"id": "GuidanceResponse.action.type",
"path": "GuidanceResponse.action.type",
"short": "create | update | remove | fire-event",
"definition": "The type of action to perform (create, update, remove).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "The type of action to be performed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-type"
}
}
},
{
"id": "GuidanceResponse.action.groupingBehavior",
"path": "GuidanceResponse.action.groupingBehavior",
"short": "visual-group | logical-group | sentence-group",
"definition": "Defines the grouping behavior for the action and its children.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines organization behavior of a group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-grouping-behavior"
}
}
},
{
"id": "GuidanceResponse.action.selectionBehavior",
"path": "GuidanceResponse.action.selectionBehavior",
"short": "any | all | all-or-none | exactly-one | at-most-one | one-or-more",
"definition": "Defines the selection behavior for the action and its children.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines selection behavior of a group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-selection-behavior"
}
}
},
{
"id": "GuidanceResponse.action.requiredBehavior",
"path": "GuidanceResponse.action.requiredBehavior",
"short": "must | could | must-unless-documented",
"definition": "Defines the requiredness behavior for the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines requiredness behavior for selecting an action or an action group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-required-behavior"
}
}
},
{
"id": "GuidanceResponse.action.precheckBehavior",
"path": "GuidanceResponse.action.precheckBehavior",
"short": "yes | no",
"definition": "Defines whether the action should usually be preselected.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines selection frequency behavior for an action or group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-precheck-behavior"
}
}
},
{
"id": "GuidanceResponse.action.cardinalityBehavior",
"path": "GuidanceResponse.action.cardinalityBehavior",
"short": "single | multiple",
"definition": "Defines whether the action can be selected multiple times.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Defines behavior for an action or a group for how many times that item may be repeated",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-cardinality-behavior"
}
}
},
{
"id": "GuidanceResponse.action.resource",
"path": "GuidanceResponse.action.resource",
"short": "The target of the action",
"definition": "The resource that is the target of the action (e.g. CommunicationRequest).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"id": "GuidanceResponse.action.action",
"path": "GuidanceResponse.action.action",
"short": "Sub action",
"definition": "Sub actions.",
"min": 0,
"max": "*",
"contentReference": "#GuidanceResponse.action"
},
{
"id": "GuidanceResponse.dataRequirement",
"path": "GuidanceResponse.dataRequirement",
"short": "Additional required data",
"definition": "If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.",
"min": 0,
"max": "*",
"type": [
{
"code": "DataRequirement"
}
]
}
]
}
}
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 STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:06+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change