Da Vinci - Documentation Templates and Rules
2.2.0 - STU 2.2 United States of America flag

Da Vinci - Documentation Templates and Rules, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-dtr/ and changes regularly. See the Directory of published versions

Logical Model: DTR Metric Data

Official URL: http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/DTRMetricData Version: 2.2.0
Standards status: Informative Maturity Level: 1 Computable Name: DTRMetricData
Other Identifiers: OID:2.16.840.1.113883.4.642.40.22.42.3

A logical model describing the information that should be captured by DTR implementers about every DTR invocation to support measures evaluating DTR implementation.

Usages:

  • This Logical Model is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DTRMetricData C 0..* Base DTR Metric Data
DTRMetricData.source 1..1 code provider-src | payer-src | DTRApp-src
Binding: MetricSource (2.2.0) (required)
DTRMetricData.sofApp 0..1 url URL of SMART on FHIR application
DTRMetricData.providerId 0..1 Identifier Identifier for the user initiating DTR
DTRMetricData.providerId.system 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi (extensions allowed)
DTRMetricData.providerId.value 1..1 string The value that is unique
DTRMetricData.groupId.system 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi (extensions allowed)
DTRMetricData.groupId.value 1..1 string The value that is unique
DTRMetricData.payerId 1..1 Identifier Payer receiving DTR request
DTRMetricData.payerId.system 1..1 uri The namespace for the identifier value
DTRMetricData.payerId.value 1..1 string The value that is unique
DTRMetricData.assertionId 0..* string Unique ID for order item
DTRMetricData.docReason 0..* code withpa | withclaim | withorder | retain-doc | OTH
Binding: CRDDocReason (2.2.1) (required)
DTRMetricData.launchMode 0..1 code crdlaunch | relaunch | salaunch | cdexlaunch
Binding: MetricLaunchMode (2.2.0) (required)
DTRMetricData.orderItem 1..* CodeableConcept What was ordered
Binding: MetricOrderDetail (2.2.1) (extensible)
DTRMetricData.action 1..* BackboneElement Actions the reporting system engaged in as part of the DTR session.
DTRMetricData.action.actionDetail 1..1 code launch | qpackage | mrquery | userresponse | nextq | storeqr
Binding: MetricAction (2.2.0) (required)
DTRMetricData.action.requestTime 1..1 instant Time action initiated
DTRMetricData.action.responseTime 0..1 instant Time of action response
DTRMetricData.action.httpResponse 0..1 integer HTTP response status code
DTRMetricData.action.questionnaire 0..1 canonical(DTR Standard Questionnaire(2.2.0) | DTR Questionnaire for adaptive form(2.2.0)) Associated Questionnaire
DTRMetricData.action.issue 0..* BackboneElement OperationOutcome info
DTRMetricData.action.issue.code 1..1 code Error code
Binding: IssueType (required)
DTRMetricData.action.issue.details 0..1 CodeableConcept More detailed error code
Binding: OperationOutcomeCodes (example)
DTRMetricData.resources 0..* BackboneElement Resource types accessed
DTRMetricData.resources.type 1..1 code Kind of resource
Binding: ResourceType (required)
DTRMetricData.resources.profile 0..1 canonical(StructureDefinition) Solicited profile
DTRMetricData.resources.count 1..1 positiveInt Number retrieved
DTRMetricData.questionnaire 0..* BackboneElement Questionnaire
DTRMetricData.questionnaire.reference 1..1 canonical(DTR Standard Questionnaire(2.2.0) | DTR Questionnaire for adaptive form(2.2.0)) This is the URL for the canonical questionnaire
DTRMetricData.questionnaire.adaptive 0..1 boolean True if adaptive form
DTRMetricData.questionnaire.populated 0..1 boolean Whether a pre-populated response was provided from payer
DTRMetricData.questionnaire.failure 0..* CodeableConcept Questionnaire errors logged to payer
Binding: IssueType (required)
DTRMetricData.questionnaire.reviewPrior 0..1 boolean True if user reviewed answers prior to final save
DTRMetricData.questionnaire.enabledQuestions 0..1 positiveInt Number of enabled questions
DTRMetricData.questionnaire.autoPopulated 0..1 positiveInt Number of questions autopopulated
DTRMetricData.questionnaire.roleInteraction 0..* BackboneElement Role specific interactions
DTRMetricData.questionnaire.roleInteraction.role 1..1 CodeableConcept Role of information contributor
Binding: USCoreProviderRoleNucc (3.1.1) (extensible)
DTRMetricData.questionnaire.roleInteraction.roleAction 1..1 code override | manual
Binding: MetricsInformationOrigins (2.2.0) (extensible)
DTRMetricData.questionnaire.roleInteraction.count 1..1 positiveInt Count of combination of role and roleInteraction
DTRMetricData.questionnaire.elapsedTime 1..1 time Cumulative user response time that questionnaire was active in session
DTRMetricData.coverageInfo 0..* BackboneElement Coverage information
DTRMetricData.coverageInfo.covered 0..1 code covered | not-covered | conditional
Binding: CRDCoveredInfo (2.2.1) (required)
DTRMetricData.coverageInfo.paNeeded 0..1 code auth-needed | no-auth | satisfied | performpa | conditional
Binding: CRDCoveragePaDetail (2.2.1) (required)
DTRMetricData.coverageInfo.docNeeded 0..1 code clinical | admin | both | conditional
Binding: CRDAdditionalDoc (2.2.1) (required)
DTRMetricData.coverageInfo.infoNeeded 0..1 code performer | location | timeframe | OTH
Binding: CRDInformationNeeded (2.2.1) (required)
DTRMetricData.coverageInfo.questionnaire 0..* BackboneElement Questionnaire(s) returned
DTRMetricData.coverageInfo.questionnaire.reference 1..1 canonical(Questionnaire) Questionnaire url & version
DTRMetricData.coverageInfo.questionnaire.adaptive 1..1 boolean Is questionnaire adaptive?
DTRMetricData.coverageInfo.questionnaire.response 1..1 boolean Pre-pop response provided?
DTRMetricData.coverageInfo.assertionId 1..1 string Id for coverage assertion
DTRMetricData.coverageInfo.satisfiedId 0..1 string Id if PA is satisfied
DTRMetricData.coverageInfo.businessLine 0..1 CodeableConcept e.g., MedicareAdvantage

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DTRMetricData.source Base required Metric Source 📍2.2.0 This IG
DTRMetricData.docReason Base required CRD Coverage Information Documentation Reason Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.launchMode Base required Metric Launch Mode 📍2.2.0 This IG
DTRMetricData.orderItem Base extensible CRD Order Detail Codes Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.action.​actionDetail Base required Metric Action 📍2.2.0 This IG
DTRMetricData.action.​issue.code Base required IssueType 📦4.0.1 FHIR Std.
DTRMetricData.action.​issue.details Base example Operation Outcome Codes 📦4.0.1 FHIR Std.
DTRMetricData.resources.​type Base required ResourceType 📦4.0.1 FHIR Std.
DTRMetricData.questionnaire.​failure Base required IssueType 📦4.0.1 FHIR Std.
DTRMetricData.questionnaire.​roleInteraction.role Base extensible US Core Provider Role (NUCC) 📍3.1.1 US Core v3.1
DTRMetricData.questionnaire.​roleInteraction.roleAction Base extensible Information Human Origins Value Set 📍2.2.0 This IG
DTRMetricData.coverageInfo.​covered Base required CRD Coverage Information Covered Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.coverageInfo.​paNeeded Base required CRD Coverage Information Prior Authorization Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.coverageInfo.​docNeeded Base required CRD Coverage Information Additional Documentation Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.coverageInfo.​infoNeeded Base required CRD Information Needed Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2

Constraints

Id Grade Path(s) Description Expression
dtrl-1 error DTRMetricData if source is not 'payer-src', then providerId and groupId are required (source!='payer-src') implies (providerId.exists() and groupId.exists())
NameFlagsCard.TypeDescription & Constraints    Filter: doco
DTRMetricData C 0..* Base DTR Metric Data
Constraints: dtrl-1
DTRMetricData.source 1..1 code provider-src | payer-src | DTRApp-src
Binding: MetricSource (2.2.0) (required)
DTRMetricData.sofApp 0..1 url URL of SMART on FHIR application
DTRMetricData.providerId 0..1 Identifier Identifier for the user initiating DTR
DTRMetricData.providerId.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.providerId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.providerId.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
DTRMetricData.providerId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
DTRMetricData.providerId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi (extensions allowed)
DTRMetricData.providerId.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
DTRMetricData.providerId.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
DTRMetricData.providerId.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
DTRMetricData.groupId 0..1 Identifier Identifier for the healthcare organization initiating DTR
DTRMetricData.groupId.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.groupId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.groupId.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
DTRMetricData.groupId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
DTRMetricData.groupId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi (extensions allowed)
DTRMetricData.groupId.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
DTRMetricData.groupId.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
DTRMetricData.groupId.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
DTRMetricData.payerId 1..1 Identifier Payer receiving DTR request
DTRMetricData.payerId.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.payerId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.payerId.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
DTRMetricData.payerId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
DTRMetricData.payerId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
DTRMetricData.payerId.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
DTRMetricData.payerId.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
DTRMetricData.payerId.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
DTRMetricData.assertionId 0..* string Unique ID for order item
DTRMetricData.docReason 0..* code withpa | withclaim | withorder | retain-doc | OTH
Binding: CRDDocReason (2.2.1) (required)
DTRMetricData.launchMode 0..1 code crdlaunch | relaunch | salaunch | cdexlaunch
Binding: MetricLaunchMode (2.2.0) (required)
DTRMetricData.orderItem 1..* CodeableConcept What was ordered
Binding: MetricOrderDetail (2.2.1) (extensible)
DTRMetricData.action 1..* BackboneElement Actions the reporting system engaged in as part of the DTR session.
DTRMetricData.action.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.action.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.action.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DTRMetricData.action.actionDetail 1..1 code launch | qpackage | mrquery | userresponse | nextq | storeqr
Binding: MetricAction (2.2.0) (required)
DTRMetricData.action.requestTime 1..1 instant Time action initiated
DTRMetricData.action.responseTime 0..1 instant Time of action response
DTRMetricData.action.httpResponse 0..1 integer HTTP response status code
DTRMetricData.action.questionnaire 0..1 canonical(DTR Standard Questionnaire(2.2.0) | DTR Questionnaire for adaptive form(2.2.0)) Associated Questionnaire
DTRMetricData.action.issue 0..* BackboneElement OperationOutcome info
DTRMetricData.action.issue.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.action.issue.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.action.issue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DTRMetricData.action.issue.code 1..1 code Error code
Binding: IssueType (required)
DTRMetricData.action.issue.details 0..1 CodeableConcept More detailed error code
Binding: OperationOutcomeCodes (example)
DTRMetricData.resources 0..* BackboneElement Resource types accessed
DTRMetricData.resources.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.resources.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.resources.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DTRMetricData.resources.type 1..1 code Kind of resource
Binding: ResourceType (required)
DTRMetricData.resources.profile 0..1 canonical(StructureDefinition) Solicited profile
DTRMetricData.resources.count 1..1 positiveInt Number retrieved
DTRMetricData.questionnaire 0..* BackboneElement Questionnaire
DTRMetricData.questionnaire.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.questionnaire.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.questionnaire.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DTRMetricData.questionnaire.reference 1..1 canonical(DTR Standard Questionnaire(2.2.0) | DTR Questionnaire for adaptive form(2.2.0)) This is the URL for the canonical questionnaire
DTRMetricData.questionnaire.adaptive 0..1 boolean True if adaptive form
DTRMetricData.questionnaire.populated 0..1 boolean Whether a pre-populated response was provided from payer
DTRMetricData.questionnaire.failure 0..* CodeableConcept Questionnaire errors logged to payer
Binding: IssueType (required)
DTRMetricData.questionnaire.reviewPrior 0..1 boolean True if user reviewed answers prior to final save
DTRMetricData.questionnaire.enabledQuestions 0..1 positiveInt Number of enabled questions
DTRMetricData.questionnaire.autoPopulated 0..1 positiveInt Number of questions autopopulated
DTRMetricData.questionnaire.roleInteraction 0..* BackboneElement Role specific interactions
DTRMetricData.questionnaire.roleInteraction.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.questionnaire.roleInteraction.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.questionnaire.roleInteraction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DTRMetricData.questionnaire.roleInteraction.role 1..1 CodeableConcept Role of information contributor
Binding: USCoreProviderRoleNucc (3.1.1) (extensible)
DTRMetricData.questionnaire.roleInteraction.roleAction 1..1 code override | manual
Binding: MetricsInformationOrigins (2.2.0) (extensible)
DTRMetricData.questionnaire.roleInteraction.count 1..1 positiveInt Count of combination of role and roleInteraction
DTRMetricData.questionnaire.elapsedTime 1..1 time Cumulative user response time that questionnaire was active in session
DTRMetricData.coverageInfo 0..* BackboneElement Coverage information
DTRMetricData.coverageInfo.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.coverageInfo.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.coverageInfo.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DTRMetricData.coverageInfo.covered 0..1 code covered | not-covered | conditional
Binding: CRDCoveredInfo (2.2.1) (required)
DTRMetricData.coverageInfo.paNeeded 0..1 code auth-needed | no-auth | satisfied | performpa | conditional
Binding: CRDCoveragePaDetail (2.2.1) (required)
DTRMetricData.coverageInfo.docNeeded 0..1 code clinical | admin | both | conditional
Binding: CRDAdditionalDoc (2.2.1) (required)
DTRMetricData.coverageInfo.infoNeeded 0..1 code performer | location | timeframe | OTH
Binding: CRDInformationNeeded (2.2.1) (required)
DTRMetricData.coverageInfo.questionnaire 0..* BackboneElement Questionnaire(s) returned
DTRMetricData.coverageInfo.questionnaire.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.coverageInfo.questionnaire.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.coverageInfo.questionnaire.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DTRMetricData.coverageInfo.questionnaire.reference 1..1 canonical(Questionnaire) Questionnaire url & version
DTRMetricData.coverageInfo.questionnaire.adaptive 1..1 boolean Is questionnaire adaptive?
DTRMetricData.coverageInfo.questionnaire.response 1..1 boolean Pre-pop response provided?
DTRMetricData.coverageInfo.assertionId 1..1 string Id for coverage assertion
DTRMetricData.coverageInfo.satisfiedId 0..1 string Id if PA is satisfied
DTRMetricData.coverageInfo.businessLine 0..1 CodeableConcept e.g., MedicareAdvantage

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DTRMetricData.source Base required Metric Source 📍2.2.0 This IG
DTRMetricData.providerId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DTRMetricData.providerId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DTRMetricData.groupId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DTRMetricData.groupId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DTRMetricData.payerId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DTRMetricData.payerId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DTRMetricData.docReason Base required CRD Coverage Information Documentation Reason Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.launchMode Base required Metric Launch Mode 📍2.2.0 This IG
DTRMetricData.orderItem Base extensible CRD Order Detail Codes Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.action.​actionDetail Base required Metric Action 📍2.2.0 This IG
DTRMetricData.action.​issue.code Base required IssueType 📦4.0.1 FHIR Std.
DTRMetricData.action.​issue.details Base example Operation Outcome Codes 📦4.0.1 FHIR Std.
DTRMetricData.resources.​type Base required ResourceType 📦4.0.1 FHIR Std.
DTRMetricData.questionnaire.​failure Base required IssueType 📦4.0.1 FHIR Std.
DTRMetricData.questionnaire.​roleInteraction.role Base extensible US Core Provider Role (NUCC) 📍3.1.1 US Core v3.1
DTRMetricData.questionnaire.​roleInteraction.roleAction Base extensible Information Human Origins Value Set 📍2.2.0 This IG
DTRMetricData.coverageInfo.​covered Base required CRD Coverage Information Covered Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.coverageInfo.​paNeeded Base required CRD Coverage Information Prior Authorization Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.coverageInfo.​docNeeded Base required CRD Coverage Information Additional Documentation Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.coverageInfo.​infoNeeded Base required CRD Information Needed Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2

Constraints

Id Grade Path(s) Description Expression
dtrl-1 error DTRMetricData if source is not 'payer-src', then providerId and groupId are required (source!='payer-src') implies (providerId.exists() and groupId.exists())

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DTRMetricData C 0..* Base DTR Metric Data
DTRMetricData.source 1..1 code provider-src | payer-src | DTRApp-src
Binding: MetricSource (2.2.0) (required)
DTRMetricData.sofApp 0..1 url URL of SMART on FHIR application
DTRMetricData.providerId 0..1 Identifier Identifier for the user initiating DTR
DTRMetricData.providerId.system 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi (extensions allowed)
DTRMetricData.providerId.value 1..1 string The value that is unique
DTRMetricData.groupId 0..1 Identifier Identifier for the healthcare organization initiating DTR
DTRMetricData.groupId.system 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi (extensions allowed)
DTRMetricData.groupId.value 1..1 string The value that is unique
DTRMetricData.payerId 1..1 Identifier Payer receiving DTR request
DTRMetricData.payerId.system 1..1 uri The namespace for the identifier value
DTRMetricData.payerId.value 1..1 string The value that is unique
DTRMetricData.assertionId 0..* string Unique ID for order item
DTRMetricData.docReason 0..* code withpa | withclaim | withorder | retain-doc | OTH
Binding: CRDDocReason (2.2.1) (required)
DTRMetricData.launchMode 0..1 code crdlaunch | relaunch | salaunch | cdexlaunch
Binding: MetricLaunchMode (2.2.0) (required)
DTRMetricData.orderItem 1..* CodeableConcept What was ordered
Binding: MetricOrderDetail (2.2.1) (extensible)
DTRMetricData.action 1..* BackboneElement Actions the reporting system engaged in as part of the DTR session.
DTRMetricData.action.actionDetail 1..1 code launch | qpackage | mrquery | userresponse | nextq | storeqr
Binding: MetricAction (2.2.0) (required)
DTRMetricData.action.requestTime 1..1 instant Time action initiated
DTRMetricData.action.responseTime 0..1 instant Time of action response
DTRMetricData.action.httpResponse 0..1 integer HTTP response status code
DTRMetricData.action.questionnaire 0..1 canonical(DTR Standard Questionnaire(2.2.0) | DTR Questionnaire for adaptive form(2.2.0)) Associated Questionnaire
DTRMetricData.action.issue 0..* BackboneElement OperationOutcome info
DTRMetricData.action.issue.code 1..1 code Error code
Binding: IssueType (required)
DTRMetricData.action.issue.details 0..1 CodeableConcept More detailed error code
Binding: OperationOutcomeCodes (example)
DTRMetricData.resources 0..* BackboneElement Resource types accessed
DTRMetricData.resources.type 1..1 code Kind of resource
Binding: ResourceType (required)
DTRMetricData.resources.profile 0..1 canonical(StructureDefinition) Solicited profile
DTRMetricData.resources.count 1..1 positiveInt Number retrieved
DTRMetricData.questionnaire 0..* BackboneElement Questionnaire
DTRMetricData.questionnaire.reference 1..1 canonical(DTR Standard Questionnaire(2.2.0) | DTR Questionnaire for adaptive form(2.2.0)) This is the URL for the canonical questionnaire
DTRMetricData.questionnaire.adaptive 0..1 boolean True if adaptive form
DTRMetricData.questionnaire.populated 0..1 boolean Whether a pre-populated response was provided from payer
DTRMetricData.questionnaire.failure 0..* CodeableConcept Questionnaire errors logged to payer
Binding: IssueType (required)
DTRMetricData.questionnaire.reviewPrior 0..1 boolean True if user reviewed answers prior to final save
DTRMetricData.questionnaire.enabledQuestions 0..1 positiveInt Number of enabled questions
DTRMetricData.questionnaire.autoPopulated 0..1 positiveInt Number of questions autopopulated
DTRMetricData.questionnaire.roleInteraction 0..* BackboneElement Role specific interactions
DTRMetricData.questionnaire.roleInteraction.role 1..1 CodeableConcept Role of information contributor
Binding: USCoreProviderRoleNucc (3.1.1) (extensible)
DTRMetricData.questionnaire.roleInteraction.roleAction 1..1 code override | manual
Binding: MetricsInformationOrigins (2.2.0) (extensible)
DTRMetricData.questionnaire.roleInteraction.count 1..1 positiveInt Count of combination of role and roleInteraction
DTRMetricData.questionnaire.elapsedTime 1..1 time Cumulative user response time that questionnaire was active in session
DTRMetricData.coverageInfo 0..* BackboneElement Coverage information
DTRMetricData.coverageInfo.covered 0..1 code covered | not-covered | conditional
Binding: CRDCoveredInfo (2.2.1) (required)
DTRMetricData.coverageInfo.paNeeded 0..1 code auth-needed | no-auth | satisfied | performpa | conditional
Binding: CRDCoveragePaDetail (2.2.1) (required)
DTRMetricData.coverageInfo.docNeeded 0..1 code clinical | admin | both | conditional
Binding: CRDAdditionalDoc (2.2.1) (required)
DTRMetricData.coverageInfo.infoNeeded 0..1 code performer | location | timeframe | OTH
Binding: CRDInformationNeeded (2.2.1) (required)
DTRMetricData.coverageInfo.questionnaire 0..* BackboneElement Questionnaire(s) returned
DTRMetricData.coverageInfo.questionnaire.reference 1..1 canonical(Questionnaire) Questionnaire url & version
DTRMetricData.coverageInfo.questionnaire.adaptive 1..1 boolean Is questionnaire adaptive?
DTRMetricData.coverageInfo.questionnaire.response 1..1 boolean Pre-pop response provided?
DTRMetricData.coverageInfo.assertionId 1..1 string Id for coverage assertion
DTRMetricData.coverageInfo.satisfiedId 0..1 string Id if PA is satisfied
DTRMetricData.coverageInfo.businessLine 0..1 CodeableConcept e.g., MedicareAdvantage

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DTRMetricData.source Base required Metric Source 📍2.2.0 This IG
DTRMetricData.docReason Base required CRD Coverage Information Documentation Reason Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.launchMode Base required Metric Launch Mode 📍2.2.0 This IG
DTRMetricData.orderItem Base extensible CRD Order Detail Codes Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.action.​actionDetail Base required Metric Action 📍2.2.0 This IG
DTRMetricData.action.​issue.code Base required IssueType 📦4.0.1 FHIR Std.
DTRMetricData.action.​issue.details Base example Operation Outcome Codes 📦4.0.1 FHIR Std.
DTRMetricData.resources.​type Base required ResourceType 📦4.0.1 FHIR Std.
DTRMetricData.questionnaire.​failure Base required IssueType 📦4.0.1 FHIR Std.
DTRMetricData.questionnaire.​roleInteraction.role Base extensible US Core Provider Role (NUCC) 📍3.1.1 US Core v3.1
DTRMetricData.questionnaire.​roleInteraction.roleAction Base extensible Information Human Origins Value Set 📍2.2.0 This IG
DTRMetricData.coverageInfo.​covered Base required CRD Coverage Information Covered Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.coverageInfo.​paNeeded Base required CRD Coverage Information Prior Authorization Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.coverageInfo.​docNeeded Base required CRD Coverage Information Additional Documentation Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.coverageInfo.​infoNeeded Base required CRD Information Needed Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2

Constraints

Id Grade Path(s) Description Expression
dtrl-1 error DTRMetricData if source is not 'payer-src', then providerId and groupId are required (source!='payer-src') implies (providerId.exists() and groupId.exists())

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DTRMetricData C 0..* Base DTR Metric Data
Constraints: dtrl-1
DTRMetricData.source 1..1 code provider-src | payer-src | DTRApp-src
Binding: MetricSource (2.2.0) (required)
DTRMetricData.sofApp 0..1 url URL of SMART on FHIR application
DTRMetricData.providerId 0..1 Identifier Identifier for the user initiating DTR
DTRMetricData.providerId.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.providerId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.providerId.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
DTRMetricData.providerId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
DTRMetricData.providerId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi (extensions allowed)
DTRMetricData.providerId.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
DTRMetricData.providerId.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
DTRMetricData.providerId.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
DTRMetricData.groupId 0..1 Identifier Identifier for the healthcare organization initiating DTR
DTRMetricData.groupId.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.groupId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.groupId.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
DTRMetricData.groupId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
DTRMetricData.groupId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi (extensions allowed)
DTRMetricData.groupId.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
DTRMetricData.groupId.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
DTRMetricData.groupId.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
DTRMetricData.payerId 1..1 Identifier Payer receiving DTR request
DTRMetricData.payerId.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.payerId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.payerId.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
DTRMetricData.payerId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
DTRMetricData.payerId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
DTRMetricData.payerId.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
DTRMetricData.payerId.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
DTRMetricData.payerId.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
DTRMetricData.assertionId 0..* string Unique ID for order item
DTRMetricData.docReason 0..* code withpa | withclaim | withorder | retain-doc | OTH
Binding: CRDDocReason (2.2.1) (required)
DTRMetricData.launchMode 0..1 code crdlaunch | relaunch | salaunch | cdexlaunch
Binding: MetricLaunchMode (2.2.0) (required)
DTRMetricData.orderItem 1..* CodeableConcept What was ordered
Binding: MetricOrderDetail (2.2.1) (extensible)
DTRMetricData.action 1..* BackboneElement Actions the reporting system engaged in as part of the DTR session.
DTRMetricData.action.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.action.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.action.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DTRMetricData.action.actionDetail 1..1 code launch | qpackage | mrquery | userresponse | nextq | storeqr
Binding: MetricAction (2.2.0) (required)
DTRMetricData.action.requestTime 1..1 instant Time action initiated
DTRMetricData.action.responseTime 0..1 instant Time of action response
DTRMetricData.action.httpResponse 0..1 integer HTTP response status code
DTRMetricData.action.questionnaire 0..1 canonical(DTR Standard Questionnaire(2.2.0) | DTR Questionnaire for adaptive form(2.2.0)) Associated Questionnaire
DTRMetricData.action.issue 0..* BackboneElement OperationOutcome info
DTRMetricData.action.issue.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.action.issue.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.action.issue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DTRMetricData.action.issue.code 1..1 code Error code
Binding: IssueType (required)
DTRMetricData.action.issue.details 0..1 CodeableConcept More detailed error code
Binding: OperationOutcomeCodes (example)
DTRMetricData.resources 0..* BackboneElement Resource types accessed
DTRMetricData.resources.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.resources.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.resources.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DTRMetricData.resources.type 1..1 code Kind of resource
Binding: ResourceType (required)
DTRMetricData.resources.profile 0..1 canonical(StructureDefinition) Solicited profile
DTRMetricData.resources.count 1..1 positiveInt Number retrieved
DTRMetricData.questionnaire 0..* BackboneElement Questionnaire
DTRMetricData.questionnaire.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.questionnaire.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.questionnaire.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DTRMetricData.questionnaire.reference 1..1 canonical(DTR Standard Questionnaire(2.2.0) | DTR Questionnaire for adaptive form(2.2.0)) This is the URL for the canonical questionnaire
DTRMetricData.questionnaire.adaptive 0..1 boolean True if adaptive form
DTRMetricData.questionnaire.populated 0..1 boolean Whether a pre-populated response was provided from payer
DTRMetricData.questionnaire.failure 0..* CodeableConcept Questionnaire errors logged to payer
Binding: IssueType (required)
DTRMetricData.questionnaire.reviewPrior 0..1 boolean True if user reviewed answers prior to final save
DTRMetricData.questionnaire.enabledQuestions 0..1 positiveInt Number of enabled questions
DTRMetricData.questionnaire.autoPopulated 0..1 positiveInt Number of questions autopopulated
DTRMetricData.questionnaire.roleInteraction 0..* BackboneElement Role specific interactions
DTRMetricData.questionnaire.roleInteraction.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.questionnaire.roleInteraction.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.questionnaire.roleInteraction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DTRMetricData.questionnaire.roleInteraction.role 1..1 CodeableConcept Role of information contributor
Binding: USCoreProviderRoleNucc (3.1.1) (extensible)
DTRMetricData.questionnaire.roleInteraction.roleAction 1..1 code override | manual
Binding: MetricsInformationOrigins (2.2.0) (extensible)
DTRMetricData.questionnaire.roleInteraction.count 1..1 positiveInt Count of combination of role and roleInteraction
DTRMetricData.questionnaire.elapsedTime 1..1 time Cumulative user response time that questionnaire was active in session
DTRMetricData.coverageInfo 0..* BackboneElement Coverage information
DTRMetricData.coverageInfo.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.coverageInfo.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.coverageInfo.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DTRMetricData.coverageInfo.covered 0..1 code covered | not-covered | conditional
Binding: CRDCoveredInfo (2.2.1) (required)
DTRMetricData.coverageInfo.paNeeded 0..1 code auth-needed | no-auth | satisfied | performpa | conditional
Binding: CRDCoveragePaDetail (2.2.1) (required)
DTRMetricData.coverageInfo.docNeeded 0..1 code clinical | admin | both | conditional
Binding: CRDAdditionalDoc (2.2.1) (required)
DTRMetricData.coverageInfo.infoNeeded 0..1 code performer | location | timeframe | OTH
Binding: CRDInformationNeeded (2.2.1) (required)
DTRMetricData.coverageInfo.questionnaire 0..* BackboneElement Questionnaire(s) returned
DTRMetricData.coverageInfo.questionnaire.@id 0..1 string Unique id for inter-element referencing
DTRMetricData.coverageInfo.questionnaire.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DTRMetricData.coverageInfo.questionnaire.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DTRMetricData.coverageInfo.questionnaire.reference 1..1 canonical(Questionnaire) Questionnaire url & version
DTRMetricData.coverageInfo.questionnaire.adaptive 1..1 boolean Is questionnaire adaptive?
DTRMetricData.coverageInfo.questionnaire.response 1..1 boolean Pre-pop response provided?
DTRMetricData.coverageInfo.assertionId 1..1 string Id for coverage assertion
DTRMetricData.coverageInfo.satisfiedId 0..1 string Id if PA is satisfied
DTRMetricData.coverageInfo.businessLine 0..1 CodeableConcept e.g., MedicareAdvantage

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DTRMetricData.source Base required Metric Source 📍2.2.0 This IG
DTRMetricData.providerId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DTRMetricData.providerId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DTRMetricData.groupId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DTRMetricData.groupId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DTRMetricData.payerId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DTRMetricData.payerId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DTRMetricData.docReason Base required CRD Coverage Information Documentation Reason Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.launchMode Base required Metric Launch Mode 📍2.2.0 This IG
DTRMetricData.orderItem Base extensible CRD Order Detail Codes Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.action.​actionDetail Base required Metric Action 📍2.2.0 This IG
DTRMetricData.action.​issue.code Base required IssueType 📦4.0.1 FHIR Std.
DTRMetricData.action.​issue.details Base example Operation Outcome Codes 📦4.0.1 FHIR Std.
DTRMetricData.resources.​type Base required ResourceType 📦4.0.1 FHIR Std.
DTRMetricData.questionnaire.​failure Base required IssueType 📦4.0.1 FHIR Std.
DTRMetricData.questionnaire.​roleInteraction.role Base extensible US Core Provider Role (NUCC) 📍3.1.1 US Core v3.1
DTRMetricData.questionnaire.​roleInteraction.roleAction Base extensible Information Human Origins Value Set 📍2.2.0 This IG
DTRMetricData.coverageInfo.​covered Base required CRD Coverage Information Covered Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.coverageInfo.​paNeeded Base required CRD Coverage Information Prior Authorization Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.coverageInfo.​docNeeded Base required CRD Coverage Information Additional Documentation Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2
DTRMetricData.coverageInfo.​infoNeeded Base required CRD Information Needed Value Set 📍2.2.1 Da Vinci - Coverage Requirements Discovery v2.2

Constraints

Id Grade Path(s) Description Expression
dtrl-1 error DTRMetricData if source is not 'payer-src', then providerId and groupId are required (source!='payer-src') implies (providerId.exists() and groupId.exists())

 

Other representations of profile: CSV, Excel

Notes:

Populating Actions

The following table provides more detail about how information is to be populated from different system perspectives:

Action Systems ELement Notes
launch All requestTime Start of the DTR session (earliest time of all actions)
responseTime End of DTR session (latest time of all actions)
httpResponse / issue Failure of DTR process prior to completion or successful storage of QuestionnaireResponse for continuation
questionnaire When request for questionnaire package was initiated (Full EHR or SMART App) or was received (Payer)
qpackage Full EHR, SMART App, Payer requestTime When request for questionnaire package was initiated (Full EHR or SMART App) or was received (Payer)
responseTime When response to questionnaire package operation was returned (Payer) or received (Full EHR or SMART App)
httpResponse / issue Result of operation, including any warnings.
questionnaire The questionnaire(s) returned, if any
mrquery Light EHR, SMART App requestTime When the request for medical record data was initiated (SMART app) or received (Light EHR)
responseTime When the response to the medical record query was returned (Light EHR) or received (SMART app)
httpResponse / issue Result of query operation, including any warnings
questionnaire The questionnaire(s) whose CQL drove the need for the query
userresponse Full EHR, SMART App requestTime When the UI became available to the end user to provide responses
responseTime When the user activated a control returning control to the application (to save the form, to get another question, to close the app, etc.)
httpResponse / issue N/A
questionnaire The questionnaire the user was interacting with
nextq Full EHR, SMART App, Payer requestTime When the $next-question call was initiated (Full EHR or SMART App) or received (Payer)
responseTime When the response to the $next-question call was provided (Payer) or received (Full EHR or SMART App)
httpResponse The response from the $next-question call
questionnaire The canonical for the adaptive form being completed (NOT the contained questionnaire)
storeqr Light EHR, SMART App requestTime When the request to store a QuestionnaireResponse was initiated (SMART App) or received (Light EHR)
responseTime When the response to the Questionnaire storage request was returned (Light EHR) or received (SMART App)
httpResponse / issue The response from the attempt to store the Questionnaire Response.
questionnaire The Questionnaire whose response was being stored