Release
4
5
Clinical
Reasoning
This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v5.0.0:
R5
-
Mixed
Normative
and
STU
)
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
| Clinical Decision Support Work Group |
Maturity
Level
:
|
Trial Use | Use Context : Any |
CDSHooksGuidanceResponse
<?xml version="1.0" encoding="UTF-8"?>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. If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonica l) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(refer ence = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(c anonical) = '#').exists()).not()).trace('unmatched', id).empty() not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:refere nce/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])])) If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time. The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="cdshooksguidanceresponse"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">to do</div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="2"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="cds"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/cdshooksguidanceresponse"/> <identifier> <system value="urn:ietf:rfc:3986"/> <value value="urn:oid:2.16.840.1.113883.4.642.5.1485"/> </identifier> <version value="5.0.0"/> <name value="CDSHooksGuidanceResponse"/> <title value="C D S Hooks Guidance Response"/> <status value="draft"/> <experimental value="false"/> <date value="2020-12-28T16:55:11+11:00"/> <publisher value="HL7"/> <description value="Defines a GuidanceResponse that represents the response container for a CDS Hooks response"/> <fhirVersion value="5.0.0"/> <mapping> <identity value="workflow"/> <uri value="http://hl7.org/fhir/workflow"/> <name value="Workflow Pattern"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/fivews"/> <name value="FiveWs Pattern Mapping"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="GuidanceResponse"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/GuidanceResponse"/> <derivation value="constraint"/> <snapshot> <element id="GuidanceResponse"> <path value="GuidanceResponse"/> <short value="The formal response to a guidance request"/> <definition value="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 value="1"/> <max value="1"/> <base> <path value="GuidanceResponse"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="dom-2"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/> <expression value="contained.contained.empty()"/> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource"/> </constraint> <constraint> <key value="dom-3"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource"/> <expression value="contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofTy pe(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmat ched', id).empty()"/> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource"/> </constraint> <constraint> <key value="dom-4"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource"/> </constraint> <constraint> <key value="dom-5"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a security label"/> <expression value="contained.meta.security.empty()"/> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource"/> </constraint> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice"> <valueBoolean value="true"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation"> <valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."/> </extension> <key value="dom-6"/> <severity value="warning"/> <human value="A resource should have narrative for robust management"/> <expression value="text.`div`.exists()"/> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Entity, Role, or Act"/> </mapping> <mapping> <identity value="workflow"/> <map value="Event"/> </mapping> <mapping> <identity value="w5"/> <map value="clinical.general"/> </mapping> </element> <element id="GuidanceResponse.id"> <path value="GuidanceResponse.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comment value="Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="1"/> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="id"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="GuidanceResponse.meta"> <path value="GuidanceResponse.meta"/> <short value="Metadata about the resource"/> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure.Changes to the content might not always be associated with version changes to the resource. A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.Changes to the content might not always be associated with version changes to the resource."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Meta"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> </element> <element id="GuidanceResponse.implicitRules"> <path value="GuidanceResponse.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc."/> <comment value="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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="true"/> <isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additionalknowledge about the resource that modifies it's meaning or interpretation 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). A human-readable narrative that contains a summary of the resource and can 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. 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 information is added later. 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. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.knowledge about the resource that modifies its meaning or interpretation"/> <isSummary value="true"/> </element> <element id="GuidanceResponse.language"> <path value="GuidanceResponse.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comment value="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 value="0"/> <max value="1"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="required"/> <description value="IETF language tag for a human language"/> <valueSet value="http://hl7.org/fhir/ValueSet/all-languages|5.0.0"/> <additional> <purpose value="starter"/> <valueSet value="http://hl7.org/fhir/ValueSet/languages"/> </additional> </binding> </element> <element id="GuidanceResponse.text"> <path value="GuidanceResponse.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="A human-readable narrative that contains a summary of the resource and can 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."/> <comment value="Contained resources do not have a 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 information is added later."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Narrative"/> </type> <condition value="dom-6"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="GuidanceResponse.contained"> <path value="GuidanceResponse.contained"/> <short value="Contained, inline Resources"/> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning."/> <comment value="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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <condition value="dom-2"/> <condition value="dom-4"/> <condition value="dom-3"/> <condition value="dom-5"/> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="GuidanceResponse.extension"> <path value="GuidanceResponse.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <ordered value="false"/> <rules value="open"/> </slicing> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="GuidanceResponse.extension:cdsHooksEndpoint"> <path value="GuidanceResponse.extension"/> <sliceName value="cdsHooksEndpoint"/> <short value="Service endpoint"/> <definition value="Defines the service endpoint for the behavior implemented by the GuidanceResponse."/> <min value="1"/> <max value="1"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> </element> <element id="GuidanceResponse.modifierExtension"> <path value="GuidanceResponse.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definitionof the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/f hir/extensibility.html#modifierExtension). Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them The identifier of the request associated with this response. If an identifier 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. 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. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid The encounter during which this response was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official copmletion of an encounter but still be tied to the context of the encounter. 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. 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. 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. 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.of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."/> <comment value="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."/> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> </constraint> <mustSupport value="false"/> <isModifier value="true"/> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="GuidanceResponse.requestIdentifier"> <path value="GuidanceResponse.requestIdentifier"/> <short value="The identifier of the request associated with this response, if any"/> <definition value="The identifier of the request associated with this response. If an identifier 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 value="1"/> <max value="1"/> <base> <path value="GuidanceResponse.requestIdentifier"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Identifier"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="workflow"/> <map value="Event.basedOn"/> </mapping> </element> <element id="GuidanceResponse.identifier"> <path value="GuidanceResponse.identifier"/> <short value="Business identifier"/> <definition value="Allows a service to provide unique, business identifiers for the response."/> <min value="1"/> <max value="1"/> <base> <path value="GuidanceResponse.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <mapping> <identity value="workflow"/> <map value="Event.identifier"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.identifier"/> </mapping> </element> <element id="GuidanceResponse.module[x]"> <path value="GuidanceResponse.module[x]"/> <slicing> <discriminator> <type value="type"/> <path value="$this"/> </discriminator> <ordered value="false"/> <rules value="closed"/> </slicing> <short value="What guidance was requested"/> <definition value="An identifier, CodeableConcept or canonical reference to the guidance that was requested."/> <min value="1"/> <max value="1"/> <base> <path value="GuidanceResponse.module[x]"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="GuidanceModuleCode"/> </extension> <strength value="example"/> <valueSet value="http://hl7.org/fhir/ValueSet/guidance-module-code"/> </binding> </element> <element id="GuidanceResponse.module[x]:moduleUri"> <path value="GuidanceResponse.module[x]"/> <sliceName value="moduleUri"/> <short value="What guidance was requested"/> <definition value="An identifier, CodeableConcept or canonical reference to the guidance that was requested."/> <min value="1"/> <max value="1"/> <base> <path value="GuidanceResponse.module[x]"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="GuidanceModuleCode"/> </extension> <strength value="example"/> <valueSet value="http://hl7.org/fhir/ValueSet/guidance-module-code"/> </binding> </element> <element id="GuidanceResponse.status"> <path value="GuidanceResponse.status"/> <short value="success | data-requested | data-required | in-progress | failure | entered-in-error"/> <definition value="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."/> <comment value="This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid."/> <min value="1"/> <max value="1"/> <base> <path value="GuidanceResponse.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="true"/> <isModifierReason value="This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="GuidanceResponseStatus"/> </extension> <strength value="required"/> <description value="The status of a guidance response."/> <valueSet value="http://hl7.org/fhir/ValueSet/guidance-response-status|5.0.0"/> </binding> <mapping> <identity value="workflow"/> <map value="Event.status"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.status"/> </mapping> </element> <element id="GuidanceResponse.subject"> <path value="GuidanceResponse.subject"/> <short value="Patient the request was performed for"/> <definition value="The patient for which the request was processed."/> <min value="0"/> <max value="1"/> <base> <path value="GuidanceResponse.subject"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.subject"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.subject[x]"/> </mapping> </element> <element id="GuidanceResponse.encounter"> <path value="GuidanceResponse.encounter"/> <short value="Encounter during which the response was returned"/> <definition value="The encounter during which this response was created or to which the creation of this record is tightly associated."/> <comment value="This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official copmletion of an encounter but still be tied to the context of the encounter."/> <min value="0"/> <max value="1"/> <base> <path value="GuidanceResponse.encounter"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Encounter"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.encounter"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.context"/> </mapping> </element> <element id="GuidanceResponse.occurrenceDateTime"> <path value="GuidanceResponse.occurrenceDateTime"/> <short value="When the guidance response was processed"/> <definition value="Indicates when the guidance response was processed."/> <min value="0"/> <max value="1"/> <base> <path value="GuidanceResponse.occurrenceDateTime"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.occurrence[x]"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.done[x]"/> </mapping> </element> <element id="GuidanceResponse.performer"> <path value="GuidanceResponse.performer"/> <short value="Device returning the guidance"/> <definition value="Provides a reference to the device that performed the guidance."/> <min value="0"/> <max value="1"/> <base> <path value="GuidanceResponse.performer"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.performer.actor"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.actor"/> </mapping> </element> <element id="GuidanceResponse.reason"> <path value="GuidanceResponse.reason"/> <short value="Why guidance is needed"/> <definition value="Describes the reason for the guidance response in coded or textual form, or 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."/> <comment value="Although this reference can be used to point to any resource, it is typically expected to refer to subject-specific data appropriate to the subject of the guidance. For example, patient-based decision support would be expected to reference patient-level data. In addition, implementations should provide as much detail as possible by using the [http://hl7.org/fhir/StructureDefinition/targetElement](http://hl7.org/fhir/extensi ons/StructureDefinition-targetElement.html) and [http://hl7.org/fhir/StructureDefinition/targe tPath](http://hl7.org/fhir/extensions/StructureDefinition-targetPath.html) extensions to indicate the specific elements relevant to providing the reason for the guidance."/> <min value="0"/> <max value="*"/> <base> <path value="GuidanceResponse.reason"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableReference"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.reason"/> </mapping> <mapping> <identity value="w5"/> <map value="FiveWs.why[x]"/> </mapping> </element> <element id="GuidanceResponse.note"> <path value="GuidanceResponse.note"/> <short value="Additional notes about the response"/> <definition value="Provides a mechanism to communicate additional information about the response."/> <min value="0"/> <max value="*"/> <base> <path value="GuidanceResponse.note"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Annotation"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="workflow"/> <map value="Event.note"/> </mapping> </element> <element id="GuidanceResponse.evaluationMessage"> <path value="GuidanceResponse.evaluationMessage"/> <short value="Messages resulting from the evaluation of the artifact or artifacts"/> <definition value="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 value="0"/> <max value="1"/> <base> <path value="GuidanceResponse.evaluationMessage"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/OperationOutcome"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="GuidanceResponse.outputParameters"> <path value="GuidanceResponse.outputParameters"/> <short value="The output parameters of the evaluation, if any"/> <definition value="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 value="0"/> <max value="1"/> <base> <path value="GuidanceResponse.outputParameters"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Parameters"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="GuidanceResponse.result"> <path value="GuidanceResponse.result"/> <short value="Proposed actions, if any"/> <definition value="The actions, if any, produced by the evaluation of the artifact."/> <min value="0"/> <max value="*"/> <base> <path value="GuidanceResponse.result"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Appointment"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/AppointmentResponse"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CarePlan"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Claim"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CommunicationRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Contract"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/DeviceRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/EnrollmentRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/MedicationRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/NutritionOrder"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RequestOrchestration"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ServiceRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/SupplyRequest"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Task"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/VisionPrescription"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="true"/> <isModifier value="false"/> <isSummary value="false"/> </element> <element id="GuidanceResponse.dataRequirement"> <path value="GuidanceResponse.dataRequirement"/> <short value="Additional required data"/> <definition value="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 value="0"/> <max value="*"/> <base> <path value="GuidanceResponse.dataRequirement"/> <min value="0"/> <max value="*"/> </base> <type> <code value="DataRequirement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <mustSupport value="false"/> <isModifier value="false"/> <isSummary value="false"/> </element> </snapshot> <differential> <element id="GuidanceResponse"> <path value="GuidanceResponse"/> <min value="1"/> <max value="1"/> </element> <element id="GuidanceResponse.extension:cdsHooksEndpoint"> <path value="GuidanceResponse.extension"/> <sliceName value="cdsHooksEndpoint"/> <short value="Service endpoint"/> <definition value="Defines the service endpoint for the behavior implemented by the GuidanceResponse."/> <min value="1"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint"/> </type> </element> <element id="GuidanceResponse.requestIdentifier"> <path value="GuidanceResponse.requestIdentifier"/> <min value="1"/> <max value="1"/> </element> <element id="GuidanceResponse.identifier"> <path value="GuidanceResponse.identifier"/> <min value="1"/> <max value="1"/> </element> <element id="GuidanceResponse.moduleUri"> <path value="GuidanceResponse.moduleUri"/> <min value="1"/> <max value="1"/> </element> <element id="GuidanceResponse.subject"> <path value="GuidanceResponse.subject"/> <mustSupport value="true"/> </element> <element id="GuidanceResponse.occurrenceDateTime"> <path value="GuidanceResponse.occurrenceDateTime"/> <mustSupport value="true"/> </element> <element id="GuidanceResponse.performer"> <path value="GuidanceResponse.performer"/> <mustSupport value="true"/> </element> <element id="GuidanceResponse.result"> <path value="GuidanceResponse.result"/> <mustSupport value="true"/> </element> </differential> </ StructureDefinition >
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
R5
hl7.fhir.core#5.0.0
generated
on
Fri,
Nov
1,
2019
09:35+1100.
QA
Page
Sun,
Mar
26,
2023
15:24+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R4B
|
|
Propose
a
change