RDC Interoperability Guide
1.0.0

rdc-GuidanceResponse

Official URL: https://roche.com/fhir/iop/StructureDefinition/rdc-GuidanceResponse Version: 1.0.0
Parent:

http://hl7.org/fhir/StructureDefinition/GuidanceResponse

 Computable Name:

RdcGuidanceResponse

RDC GuidanceResponse profile for formal responses to a guidance request.

Formal Views of Profile Content

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textI0..1Narrative
containedI0..*Resource
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
requestIdentifierΣ0..0Identifier
identifierΣ0..0Identifier
moduleUriuri
moduleCanonicalcanonical()
moduleCodeableConceptCodeableConcept
statusΣ ?!1..1codeBinding
subject0..1Reference(Patient | Group)
encounter0..0Reference(Encounter)
occurrenceDateTime0..0dateTime
performer0..0Reference(Device)
reason0..*CodeableReference()
note0..0Annotation
evaluationMessage0..0Reference(OperationOutcome)
outputParameters0..0Reference(Parameters)
result0..*Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | Task | VisionPrescription)
dataRequirement0..0DataRequirement

GuidanceResponse
DefinitionA 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.
Cardinality0...*
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: 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().ofType(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('unmatched', id).empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity, Role, or Act
  • workflow: Event
  • w5: clinical.general
GuidanceResponse.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typeid
SummaryTrue
Comments

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.

GuidanceResponse.meta
DefinitionThe 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.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
GuidanceResponse.implicitRules
DefinitionA 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.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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. 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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
GuidanceResponse.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

IETF language tag for a human language

AllLanguages (required)
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).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
GuidanceResponse.text
DefinitionA 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.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
GuidanceResponse.contained
DefinitionThese 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.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained resources
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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: N/A
GuidanceResponse.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
GuidanceResponse.modifierExtension
DefinitionMay 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 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content
Requirements

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.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
GuidanceResponse.requestIdentifier
DefinitionThe 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.
Cardinality0...0
TypeIdentifier
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.basedOn
GuidanceResponse.identifier
DefinitionAllows a service to provide unique, business identifiers for the response.
Cardinality0...0
TypeIdentifier
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.identifier
  • w5: FiveWs.identifier
GuidanceResponse.module[x]
DefinitionAn identifier, CodeableConcept or canonical reference to the guidance that was requested.
Cardinality1...1
Typeuri
BindingGuidanceModuleCode (example)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
GuidanceResponse.status
DefinitionThe 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.
Cardinality1...1
Typecode
Binding

The status of a guidance response.

GuidanceResponseStatus (required)
ModifierTrue
SummaryTrue
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.status
  • w5: FiveWs.status
GuidanceResponse.subject
DefinitionThe patient for which the request was processed.
Cardinality0...1
TypeReference(Patient | Group)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.subject
  • w5: FiveWs.subject[x]
GuidanceResponse.encounter
DefinitionThe encounter during which this response was created or to which the creation of this record is tightly associated.
Cardinality0...0
TypeReference(Encounter)
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.encounter
  • w5: FiveWs.context
GuidanceResponse.occurrenceDateTime
DefinitionIndicates when the guidance response was processed.
Cardinality0...0
TypedateTime
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.occurrence[x]
  • w5: FiveWs.done[x]
GuidanceResponse.performer
DefinitionProvides a reference to the device that performed the guidance.
Cardinality0...0
TypeReference(Device)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.performer.actor
  • w5: FiveWs.actor
GuidanceResponse.reason
DefinitionDescribes 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.
Cardinality0...*
TypeCodeableReference()
Comments

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 and http://hl7.org/fhir/StructureDefinition/targetPath extensions to indicate the specific elements relevant to providing the reason for the guidance.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.reason
  • w5: FiveWs.why[x]
GuidanceResponse.note
DefinitionProvides a mechanism to communicate additional information about the response.
Cardinality0...0
TypeAnnotation
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.note
GuidanceResponse.evaluationMessage
DefinitionMessages 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.
Cardinality0...0
TypeReference(OperationOutcome)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
GuidanceResponse.outputParameters
DefinitionThe 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.
Cardinality0...0
TypeReference(Parameters)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
GuidanceResponse.result
DefinitionThe actions, if any, produced by the evaluation of the artifact.
Cardinality0...*
TypeReference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | Task | VisionPrescription)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
GuidanceResponse.dataRequirement
DefinitionIf 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.
Cardinality0...0
TypeDataRequirement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • TODO
    • <StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="rdc-GuidanceResponse" />
    <url value="https://roche.com/fhir/iop/StructureDefinition/rdc-GuidanceResponse" />
    <name value="RdcGuidanceResponse" />
    <title value="RDC GuidanceResponse" />
    <status value="draft" />
    <publisher value="F. Hoffmann-La Roche AG" />
    <description value="RDC GuidanceResponse profile for formal responses to a guidance request." />
    <purpose value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
    <fhirVersion value="5.0.0" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="GuidanceResponse" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/GuidanceResponse" />
    <derivation value="constraint" />
    <differential>
        <element id="GuidanceResponse.requestIdentifier">
            <path value="GuidanceResponse.requestIdentifier" />
            <max value="0" />
        </element>
        <element id="GuidanceResponse.identifier">
            <path value="GuidanceResponse.identifier" />
            <max value="0" />
        </element>
        <element id="GuidanceResponse.encounter">
            <path value="GuidanceResponse.encounter" />
            <max value="0" />
        </element>
        <element id="GuidanceResponse.occurrenceDateTime">
            <path value="GuidanceResponse.occurrenceDateTime" />
            <max value="0" />
        </element>
        <element id="GuidanceResponse.performer">
            <path value="GuidanceResponse.performer" />
            <max value="0" />
        </element>
        <element id="GuidanceResponse.note">
            <path value="GuidanceResponse.note" />
            <max value="0" />
        </element>
        <element id="GuidanceResponse.evaluationMessage">
            <path value="GuidanceResponse.evaluationMessage" />
            <max value="0" />
        </element>
        <element id="GuidanceResponse.outputParameters">
            <path value="GuidanceResponse.outputParameters" />
            <max value="0" />
        </element>
        <element id="GuidanceResponse.dataRequirement">
            <path value="GuidanceResponse.dataRequirement" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>

    {
    "resourceType": "StructureDefinition",
    "id": "rdc-GuidanceResponse",
    "url": "https://roche.com/fhir/iop/StructureDefinition/rdc-GuidanceResponse",
    "name": "RdcGuidanceResponse",
    "title": "RDC GuidanceResponse",
    "status": "draft",
    "publisher": "F. Hoffmann-La Roche AG",
    "description": "RDC GuidanceResponse profile for formal responses to a guidance request.",
    "purpose": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
    "fhirVersion": "5.0.0",
    "kind": "resource",
    "abstract": false,
    "type": "GuidanceResponse",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/GuidanceResponse",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "GuidanceResponse.requestIdentifier",
                "path": "GuidanceResponse.requestIdentifier",
                "max": "0"
            },
            {
                "id": "GuidanceResponse.identifier",
                "path": "GuidanceResponse.identifier",
                "max": "0"
            },
            {
                "id": "GuidanceResponse.encounter",
                "path": "GuidanceResponse.encounter",
                "max": "0"
            },
            {
                "id": "GuidanceResponse.occurrenceDateTime",
                "path": "GuidanceResponse.occurrenceDateTime",
                "max": "0"
            },
            {
                "id": "GuidanceResponse.performer",
                "path": "GuidanceResponse.performer",
                "max": "0"
            },
            {
                "id": "GuidanceResponse.note",
                "path": "GuidanceResponse.note",
                "max": "0"
            },
            {
                "id": "GuidanceResponse.evaluationMessage",
                "path": "GuidanceResponse.evaluationMessage",
                "max": "0"
            },
            {
                "id": "GuidanceResponse.outputParameters",
                "path": "GuidanceResponse.outputParameters",
                "max": "0"
            },
            {
                "id": "GuidanceResponse.dataRequirement",
                "path": "GuidanceResponse.dataRequirement",
                "max": "0"
            }
        ]
    }
}