Da Vinci - Documentation Templates and Rules
2.0.1 - STU 2 United States of America flag

This page is part of the Documentation Templates and Rules (v2.0.1: STU 2.0) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Logical Model: DTR Metric Data

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

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

This model is NOT a FHIR data structure for information exchange. Instead, it is a logical model of the information that SHOULD be collected and maintained for each DTR system action. While implementers may choose any internal storage format that is appropriate for their system, the information collected should ultimately be mapped to the information model below. Mapping implementation data to these elements will allow metrics (see the [table on the metrics page]) to be represented in a way that provides consistent responses to requirements from various interested parties (providers, payers, regulators, quality organizations, certification agencies, states, etc.) by each of the participants in the DTR exchanges. A separate instance should be created by each participant for each DTR ‘session’:

  • For a ‘Light’ EHR, a session exists from the time the DTR SMART app launches until it closes.
  • For a ‘Full’ EHR, a session exists from the time the user interface initiates the DTR process until the user interface returns from QuestionnaireResponse population to other activity.
  • For a SMART app, a session runs from the time the app is launched until it closes.
  • For a payer, a session runs from the time a SMART back-end connection from the Full EHR or SMART app is established until the last operation call is made using that security token. Resumed DTR sessions initiated from a previously stored QuestionnaireResponse will be tracked separately from initial DTR sessions. Unless there is at least one CRD-assigned assertion id present on the record, it will not be possible to tie together multiple sessions related to the same QuestionnaireResponse or order.

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. DTRMetricData 0..*BaseDTR Metric Data
Instances of this logical model are not marked to be the target of a Reference
... source 1..1codeprovider-src | payer-src | DTRApp-src
Binding: Metric Source (required)
... sofApp 0..1urlURL of SMART on FHIR application
... providerId 1..1IdentifierIdentifier for the user initiating DTR
.... system 1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... value 1..1stringThe value that is unique
.... system 1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... value 1..1stringThe value that is unique
... payerId 1..1IdentifierPayer receiving DTR request
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
... assertionId 0..*stringUnique ID for order item
... docReason 0..*codewithpa | withclaim | withorder | retain-doc | OTH
Binding: CRD Coverage Information Documentation Reason Value Set (required)
... launchMode 0..1codecrdlaunch | relaunch | salaunch | cdexlaunch
Binding: Metric Launch Mode (required)
... orderItem 1..*CodeableConceptWhat was ordered
Binding: CRD Order Detail Codes Value Set (extensible)
... action 1..*BackboneElementActions the reporting system engaged in as part of the DTR session.
.... actionDetail 1..1codelaunch | qpackage | mrquery | userresponse | nextq | storeqr
Binding: Metric Action (required)
.... requestTime 1..1instantTime action initiated
.... responseTime 0..1instantTime of action response
.... httpResponse 0..1integerHTTP response status code
.... questionnaire 0..1canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form)Associated Questionnaire
.... issue 0..*BackboneElementOperationOutcome info
..... code 1..1codeError code
Binding: IssueType (required)
..... details 0..1CodeableConceptMore detailed error code
Binding: OperationOutcomeCodes (example)
... resources 0..*BackboneElementResource types accessed
.... type 1..1codeKind of resource
Binding: ResourceType (required)
.... profile 0..1canonical(StructureDefinition)Solicited profile
.... count 1..1positiveIntNumber retrieved
... questionnaire 0..*BackboneElementQuestionnaire
.... reference 1..1canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form)This is the URL for the canonical questionnaire
.... adaptive 0..1booleanTrue if adaptive form
.... populated 0..1booleanWhether a pre-populated response was provided from payer
.... failure 0..*CodeableConceptQuestionnaire errors logged to payer
Binding: IssueType (required)
.... reviewPrior 0..1booleanTrue if user reviewed answers prior to final save
.... enabledQuestions 0..1positiveIntNumber of enabled questions
.... autoPopulated 0..1positiveIntNumber of questions autopopulated
.... roleInteraction 0..*BackboneElementRole specific interactions
..... role 1..1CodeableConceptRole of information contributor
Binding: US Core Provider Role (NUCC) (extensible)
..... roleAction 1..1codeoverride | manual
Binding: Information Human Origins Value Set (extensible)
..... count 1..1positiveIntCount of combination of role and roleInteraction
.... elapsedTime 1..1timeCumulative user response time that questionnaire was active in session
... coverageInfo 0..*BackboneElementCoverage information
.... covered 0..1codecovered | not-covered | conditional
Binding: CRD Coverage Information Covered Value Set (required)
.... paNeeded 0..1codeauth-needed | no-auth | satisfied | performpa | conditional
Binding: CRD Coverage Information Prior Authorization Value Set (required)
.... docNeeded 0..1codeclinical | admin | both | conditional
Binding: CRD Coverage Information Additional Documentation Value Set (required)
.... infoNeeded 0..1codeperformer | location | timeframe | OTH
Binding: CRD Information Needed Value Set (required)
.... questionnaire 0..*BackboneElementQuestionnaire(s) returned
..... reference 1..1canonical(Questionnaire)Questionnaire url & version
..... adaptive 1..1booleanIs questionnaire adaptive?
..... response 1..1booleanPre-pop response provided?
.... assertionId 1..1stringId for coverage assertion
.... satisfiedId 0..1stringId if PA is satisfied
.... businessLine 0..1CodeableConceptE.g. MedicareAdvantage

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
DTRMetricData.sourcerequiredMetricSource
DTRMetricData.docReasonrequiredCRDDocReason
DTRMetricData.launchModerequiredMetricLaunchMode
DTRMetricData.orderItemextensibleMetricOrderDetail
DTRMetricData.action.actionDetailrequiredMetricAction
DTRMetricData.action.issue.coderequiredIssueType
DTRMetricData.action.issue.detailsexampleOperationOutcomeCodes
DTRMetricData.resources.typerequiredResourceType
DTRMetricData.questionnaire.failurerequiredIssueType
DTRMetricData.questionnaire.roleInteraction.roleextensibleUSCoreProviderRoleNucc
DTRMetricData.questionnaire.roleInteraction.roleActionextensibleMetricsInformationOrigins
DTRMetricData.coverageInfo.coveredrequiredCRDCoveredInfo
DTRMetricData.coverageInfo.paNeededrequiredCRDCoveragePaDetail
DTRMetricData.coverageInfo.docNeededrequiredCRDAdditionalDoc
DTRMetricData.coverageInfo.infoNeededrequiredCRDInformationNeeded
NameFlagsCard.TypeDescription & Constraintsdoco
.. DTRMetricData 0..*BaseDTR Metric Data
Instances of this logical model are not marked to be the target of a Reference
... source 1..1codeprovider-src | payer-src | DTRApp-src
Binding: Metric Source (required)
... sofApp 0..1urlURL of SMART on FHIR application
... providerId 1..1IdentifierIdentifier for the user initiating DTR
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... value Σ1..1stringThe value that is unique
Example General: 123456
... payerId 1..1IdentifierPayer receiving DTR request
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
... assertionId 0..*stringUnique ID for order item
... docReason 0..*codewithpa | withclaim | withorder | retain-doc | OTH
Binding: CRD Coverage Information Documentation Reason Value Set (required)
... launchMode 0..1codecrdlaunch | relaunch | salaunch | cdexlaunch
Binding: Metric Launch Mode (required)
... orderItem 1..*CodeableConceptWhat was ordered
Binding: CRD Order Detail Codes Value Set (extensible)
... action 1..*BackboneElementActions the reporting system engaged in as part of the DTR session.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... actionDetail 1..1codelaunch | qpackage | mrquery | userresponse | nextq | storeqr
Binding: Metric Action (required)
.... requestTime 1..1instantTime action initiated
.... responseTime 0..1instantTime of action response
.... httpResponse 0..1integerHTTP response status code
.... questionnaire 0..1canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form)Associated Questionnaire
.... issue 0..*BackboneElementOperationOutcome info
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeError code
Binding: IssueType (required)
..... details 0..1CodeableConceptMore detailed error code
Binding: OperationOutcomeCodes (example)
... resources 0..*BackboneElementResource types accessed
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1codeKind of resource
Binding: ResourceType (required)
.... profile 0..1canonical(StructureDefinition)Solicited profile
.... count 1..1positiveIntNumber retrieved
... questionnaire 0..*BackboneElementQuestionnaire
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... reference 1..1canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form)This is the URL for the canonical questionnaire
.... adaptive 0..1booleanTrue if adaptive form
.... populated 0..1booleanWhether a pre-populated response was provided from payer
.... failure 0..*CodeableConceptQuestionnaire errors logged to payer
Binding: IssueType (required)
.... reviewPrior 0..1booleanTrue if user reviewed answers prior to final save
.... enabledQuestions 0..1positiveIntNumber of enabled questions
.... autoPopulated 0..1positiveIntNumber of questions autopopulated
.... roleInteraction 0..*BackboneElementRole specific interactions
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role 1..1CodeableConceptRole of information contributor
Binding: US Core Provider Role (NUCC) (extensible)
..... roleAction 1..1codeoverride | manual
Binding: Information Human Origins Value Set (extensible)
..... count 1..1positiveIntCount of combination of role and roleInteraction
.... elapsedTime 1..1timeCumulative user response time that questionnaire was active in session
... coverageInfo 0..*BackboneElementCoverage information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... covered 0..1codecovered | not-covered | conditional
Binding: CRD Coverage Information Covered Value Set (required)
.... paNeeded 0..1codeauth-needed | no-auth | satisfied | performpa | conditional
Binding: CRD Coverage Information Prior Authorization Value Set (required)
.... docNeeded 0..1codeclinical | admin | both | conditional
Binding: CRD Coverage Information Additional Documentation Value Set (required)
.... infoNeeded 0..1codeperformer | location | timeframe | OTH
Binding: CRD Information Needed Value Set (required)
.... questionnaire 0..*BackboneElementQuestionnaire(s) returned
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... reference 1..1canonical(Questionnaire)Questionnaire url & version
..... adaptive 1..1booleanIs questionnaire adaptive?
..... response 1..1booleanPre-pop response provided?
.... assertionId 1..1stringId for coverage assertion
.... satisfiedId 0..1stringId if PA is satisfied
.... businessLine 0..1CodeableConceptE.g. MedicareAdvantage

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DTRMetricData.sourcerequiredMetricSource
DTRMetricData.providerId.userequiredIdentifierUse
DTRMetricData.groupId.userequiredIdentifierUse
DTRMetricData.payerId.userequiredIdentifierUse
DTRMetricData.docReasonrequiredCRDDocReason
DTRMetricData.launchModerequiredMetricLaunchMode
DTRMetricData.orderItemextensibleMetricOrderDetail
DTRMetricData.action.actionDetailrequiredMetricAction
DTRMetricData.action.issue.coderequiredIssueType
DTRMetricData.action.issue.detailsexampleOperationOutcomeCodes
DTRMetricData.resources.typerequiredResourceType
DTRMetricData.questionnaire.failurerequiredIssueType
DTRMetricData.questionnaire.roleInteraction.roleextensibleUSCoreProviderRoleNucc
DTRMetricData.questionnaire.roleInteraction.roleActionextensibleMetricsInformationOrigins
DTRMetricData.coverageInfo.coveredrequiredCRDCoveredInfo
DTRMetricData.coverageInfo.paNeededrequiredCRDCoveragePaDetail
DTRMetricData.coverageInfo.docNeededrequiredCRDAdditionalDoc
DTRMetricData.coverageInfo.infoNeededrequiredCRDInformationNeeded
NameFlagsCard.TypeDescription & Constraintsdoco
.. DTRMetricData 0..*BaseDTR Metric Data
Instances of this logical model are not marked to be the target of a Reference
... source 1..1codeprovider-src | payer-src | DTRApp-src
Binding: Metric Source (required)
... sofApp 0..1urlURL of SMART on FHIR application
... providerId 1..1IdentifierIdentifier for the user initiating DTR
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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.

.... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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.

.... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... payerId 1..1IdentifierPayer receiving DTR request
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... assertionId 0..*stringUnique ID for order item
... docReason 0..*codewithpa | withclaim | withorder | retain-doc | OTH
Binding: CRD Coverage Information Documentation Reason Value Set (required)
... launchMode 0..1codecrdlaunch | relaunch | salaunch | cdexlaunch
Binding: Metric Launch Mode (required)
... orderItem 1..*CodeableConceptWhat was ordered
Binding: CRD Order Detail Codes Value Set (extensible)
... action 1..*BackboneElementActions the reporting system engaged in as part of the DTR session.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... actionDetail 1..1codelaunch | qpackage | mrquery | userresponse | nextq | storeqr
Binding: Metric Action (required)
.... requestTime 1..1instantTime action initiated
.... responseTime 0..1instantTime of action response
.... httpResponse 0..1integerHTTP response status code
.... questionnaire 0..1canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form)Associated Questionnaire
.... issue 0..*BackboneElementOperationOutcome info
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeError code
Binding: IssueType (required)
..... details 0..1CodeableConceptMore detailed error code
Binding: OperationOutcomeCodes (example)
... resources 0..*BackboneElementResource types accessed
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1codeKind of resource
Binding: ResourceType (required)
.... profile 0..1canonical(StructureDefinition)Solicited profile
.... count 1..1positiveIntNumber retrieved
... questionnaire 0..*BackboneElementQuestionnaire
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... reference 1..1canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form)This is the URL for the canonical questionnaire
.... adaptive 0..1booleanTrue if adaptive form
.... populated 0..1booleanWhether a pre-populated response was provided from payer
.... failure 0..*CodeableConceptQuestionnaire errors logged to payer
Binding: IssueType (required)
.... reviewPrior 0..1booleanTrue if user reviewed answers prior to final save
.... enabledQuestions 0..1positiveIntNumber of enabled questions
.... autoPopulated 0..1positiveIntNumber of questions autopopulated
.... roleInteraction 0..*BackboneElementRole specific interactions
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role 1..1CodeableConceptRole of information contributor
Binding: US Core Provider Role (NUCC) (extensible)
..... roleAction 1..1codeoverride | manual
Binding: Information Human Origins Value Set (extensible)
..... count 1..1positiveIntCount of combination of role and roleInteraction
.... elapsedTime 1..1timeCumulative user response time that questionnaire was active in session
... coverageInfo 0..*BackboneElementCoverage information
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... covered 0..1codecovered | not-covered | conditional
Binding: CRD Coverage Information Covered Value Set (required)
.... paNeeded 0..1codeauth-needed | no-auth | satisfied | performpa | conditional
Binding: CRD Coverage Information Prior Authorization Value Set (required)
.... docNeeded 0..1codeclinical | admin | both | conditional
Binding: CRD Coverage Information Additional Documentation Value Set (required)
.... infoNeeded 0..1codeperformer | location | timeframe | OTH
Binding: CRD Information Needed Value Set (required)
.... questionnaire 0..*BackboneElementQuestionnaire(s) returned
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... reference 1..1canonical(Questionnaire)Questionnaire url & version
..... adaptive 1..1booleanIs questionnaire adaptive?
..... response 1..1booleanPre-pop response provided?
.... assertionId 1..1stringId for coverage assertion
.... satisfiedId 0..1stringId if PA is satisfied
.... businessLine 0..1CodeableConceptE.g. MedicareAdvantage

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DTRMetricData.sourcerequiredMetricSource
DTRMetricData.providerId.userequiredIdentifierUse
DTRMetricData.providerId.typeextensibleIdentifier Type Codes
DTRMetricData.groupId.userequiredIdentifierUse
DTRMetricData.groupId.typeextensibleIdentifier Type Codes
DTRMetricData.payerId.userequiredIdentifierUse
DTRMetricData.payerId.typeextensibleIdentifier Type Codes
DTRMetricData.docReasonrequiredCRDDocReason
DTRMetricData.launchModerequiredMetricLaunchMode
DTRMetricData.orderItemextensibleMetricOrderDetail
DTRMetricData.action.actionDetailrequiredMetricAction
DTRMetricData.action.issue.coderequiredIssueType
DTRMetricData.action.issue.detailsexampleOperationOutcomeCodes
DTRMetricData.resources.typerequiredResourceType
DTRMetricData.questionnaire.failurerequiredIssueType
DTRMetricData.questionnaire.roleInteraction.roleextensibleUSCoreProviderRoleNucc
DTRMetricData.questionnaire.roleInteraction.roleActionextensibleMetricsInformationOrigins
DTRMetricData.coverageInfo.coveredrequiredCRDCoveredInfo
DTRMetricData.coverageInfo.paNeededrequiredCRDCoveragePaDetail
DTRMetricData.coverageInfo.docNeededrequiredCRDAdditionalDoc
DTRMetricData.coverageInfo.infoNeededrequiredCRDInformationNeeded

This structure is derived from Base

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. DTRMetricData 0..*BaseDTR Metric Data
Instances of this logical model are not marked to be the target of a Reference
... source 1..1codeprovider-src | payer-src | DTRApp-src
Binding: Metric Source (required)
... sofApp 0..1urlURL of SMART on FHIR application
... providerId 1..1IdentifierIdentifier for the user initiating DTR
.... system 1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... value 1..1stringThe value that is unique
.... system 1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... value 1..1stringThe value that is unique
... payerId 1..1IdentifierPayer receiving DTR request
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
... assertionId 0..*stringUnique ID for order item
... docReason 0..*codewithpa | withclaim | withorder | retain-doc | OTH
Binding: CRD Coverage Information Documentation Reason Value Set (required)
... launchMode 0..1codecrdlaunch | relaunch | salaunch | cdexlaunch
Binding: Metric Launch Mode (required)
... orderItem 1..*CodeableConceptWhat was ordered
Binding: CRD Order Detail Codes Value Set (extensible)
... action 1..*BackboneElementActions the reporting system engaged in as part of the DTR session.
.... actionDetail 1..1codelaunch | qpackage | mrquery | userresponse | nextq | storeqr
Binding: Metric Action (required)
.... requestTime 1..1instantTime action initiated
.... responseTime 0..1instantTime of action response
.... httpResponse 0..1integerHTTP response status code
.... questionnaire 0..1canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form)Associated Questionnaire
.... issue 0..*BackboneElementOperationOutcome info
..... code 1..1codeError code
Binding: IssueType (required)
..... details 0..1CodeableConceptMore detailed error code
Binding: OperationOutcomeCodes (example)
... resources 0..*BackboneElementResource types accessed
.... type 1..1codeKind of resource
Binding: ResourceType (required)
.... profile 0..1canonical(StructureDefinition)Solicited profile
.... count 1..1positiveIntNumber retrieved
... questionnaire 0..*BackboneElementQuestionnaire
.... reference 1..1canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form)This is the URL for the canonical questionnaire
.... adaptive 0..1booleanTrue if adaptive form
.... populated 0..1booleanWhether a pre-populated response was provided from payer
.... failure 0..*CodeableConceptQuestionnaire errors logged to payer
Binding: IssueType (required)
.... reviewPrior 0..1booleanTrue if user reviewed answers prior to final save
.... enabledQuestions 0..1positiveIntNumber of enabled questions
.... autoPopulated 0..1positiveIntNumber of questions autopopulated
.... roleInteraction 0..*BackboneElementRole specific interactions
..... role 1..1CodeableConceptRole of information contributor
Binding: US Core Provider Role (NUCC) (extensible)
..... roleAction 1..1codeoverride | manual
Binding: Information Human Origins Value Set (extensible)
..... count 1..1positiveIntCount of combination of role and roleInteraction
.... elapsedTime 1..1timeCumulative user response time that questionnaire was active in session
... coverageInfo 0..*BackboneElementCoverage information
.... covered 0..1codecovered | not-covered | conditional
Binding: CRD Coverage Information Covered Value Set (required)
.... paNeeded 0..1codeauth-needed | no-auth | satisfied | performpa | conditional
Binding: CRD Coverage Information Prior Authorization Value Set (required)
.... docNeeded 0..1codeclinical | admin | both | conditional
Binding: CRD Coverage Information Additional Documentation Value Set (required)
.... infoNeeded 0..1codeperformer | location | timeframe | OTH
Binding: CRD Information Needed Value Set (required)
.... questionnaire 0..*BackboneElementQuestionnaire(s) returned
..... reference 1..1canonical(Questionnaire)Questionnaire url & version
..... adaptive 1..1booleanIs questionnaire adaptive?
..... response 1..1booleanPre-pop response provided?
.... assertionId 1..1stringId for coverage assertion
.... satisfiedId 0..1stringId if PA is satisfied
.... businessLine 0..1CodeableConceptE.g. MedicareAdvantage

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
DTRMetricData.sourcerequiredMetricSource
DTRMetricData.docReasonrequiredCRDDocReason
DTRMetricData.launchModerequiredMetricLaunchMode
DTRMetricData.orderItemextensibleMetricOrderDetail
DTRMetricData.action.actionDetailrequiredMetricAction
DTRMetricData.action.issue.coderequiredIssueType
DTRMetricData.action.issue.detailsexampleOperationOutcomeCodes
DTRMetricData.resources.typerequiredResourceType
DTRMetricData.questionnaire.failurerequiredIssueType
DTRMetricData.questionnaire.roleInteraction.roleextensibleUSCoreProviderRoleNucc
DTRMetricData.questionnaire.roleInteraction.roleActionextensibleMetricsInformationOrigins
DTRMetricData.coverageInfo.coveredrequiredCRDCoveredInfo
DTRMetricData.coverageInfo.paNeededrequiredCRDCoveragePaDetail
DTRMetricData.coverageInfo.docNeededrequiredCRDAdditionalDoc
DTRMetricData.coverageInfo.infoNeededrequiredCRDInformationNeeded

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DTRMetricData 0..*BaseDTR Metric Data
Instances of this logical model are not marked to be the target of a Reference
... source 1..1codeprovider-src | payer-src | DTRApp-src
Binding: Metric Source (required)
... sofApp 0..1urlURL of SMART on FHIR application
... providerId 1..1IdentifierIdentifier for the user initiating DTR
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... value Σ1..1stringThe value that is unique
Example General: 123456
... payerId 1..1IdentifierPayer receiving DTR request
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
... assertionId 0..*stringUnique ID for order item
... docReason 0..*codewithpa | withclaim | withorder | retain-doc | OTH
Binding: CRD Coverage Information Documentation Reason Value Set (required)
... launchMode 0..1codecrdlaunch | relaunch | salaunch | cdexlaunch
Binding: Metric Launch Mode (required)
... orderItem 1..*CodeableConceptWhat was ordered
Binding: CRD Order Detail Codes Value Set (extensible)
... action 1..*BackboneElementActions the reporting system engaged in as part of the DTR session.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... actionDetail 1..1codelaunch | qpackage | mrquery | userresponse | nextq | storeqr
Binding: Metric Action (required)
.... requestTime 1..1instantTime action initiated
.... responseTime 0..1instantTime of action response
.... httpResponse 0..1integerHTTP response status code
.... questionnaire 0..1canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form)Associated Questionnaire
.... issue 0..*BackboneElementOperationOutcome info
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeError code
Binding: IssueType (required)
..... details 0..1CodeableConceptMore detailed error code
Binding: OperationOutcomeCodes (example)
... resources 0..*BackboneElementResource types accessed
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1codeKind of resource
Binding: ResourceType (required)
.... profile 0..1canonical(StructureDefinition)Solicited profile
.... count 1..1positiveIntNumber retrieved
... questionnaire 0..*BackboneElementQuestionnaire
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... reference 1..1canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form)This is the URL for the canonical questionnaire
.... adaptive 0..1booleanTrue if adaptive form
.... populated 0..1booleanWhether a pre-populated response was provided from payer
.... failure 0..*CodeableConceptQuestionnaire errors logged to payer
Binding: IssueType (required)
.... reviewPrior 0..1booleanTrue if user reviewed answers prior to final save
.... enabledQuestions 0..1positiveIntNumber of enabled questions
.... autoPopulated 0..1positiveIntNumber of questions autopopulated
.... roleInteraction 0..*BackboneElementRole specific interactions
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role 1..1CodeableConceptRole of information contributor
Binding: US Core Provider Role (NUCC) (extensible)
..... roleAction 1..1codeoverride | manual
Binding: Information Human Origins Value Set (extensible)
..... count 1..1positiveIntCount of combination of role and roleInteraction
.... elapsedTime 1..1timeCumulative user response time that questionnaire was active in session
... coverageInfo 0..*BackboneElementCoverage information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... covered 0..1codecovered | not-covered | conditional
Binding: CRD Coverage Information Covered Value Set (required)
.... paNeeded 0..1codeauth-needed | no-auth | satisfied | performpa | conditional
Binding: CRD Coverage Information Prior Authorization Value Set (required)
.... docNeeded 0..1codeclinical | admin | both | conditional
Binding: CRD Coverage Information Additional Documentation Value Set (required)
.... infoNeeded 0..1codeperformer | location | timeframe | OTH
Binding: CRD Information Needed Value Set (required)
.... questionnaire 0..*BackboneElementQuestionnaire(s) returned
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... reference 1..1canonical(Questionnaire)Questionnaire url & version
..... adaptive 1..1booleanIs questionnaire adaptive?
..... response 1..1booleanPre-pop response provided?
.... assertionId 1..1stringId for coverage assertion
.... satisfiedId 0..1stringId if PA is satisfied
.... businessLine 0..1CodeableConceptE.g. MedicareAdvantage

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DTRMetricData.sourcerequiredMetricSource
DTRMetricData.providerId.userequiredIdentifierUse
DTRMetricData.groupId.userequiredIdentifierUse
DTRMetricData.payerId.userequiredIdentifierUse
DTRMetricData.docReasonrequiredCRDDocReason
DTRMetricData.launchModerequiredMetricLaunchMode
DTRMetricData.orderItemextensibleMetricOrderDetail
DTRMetricData.action.actionDetailrequiredMetricAction
DTRMetricData.action.issue.coderequiredIssueType
DTRMetricData.action.issue.detailsexampleOperationOutcomeCodes
DTRMetricData.resources.typerequiredResourceType
DTRMetricData.questionnaire.failurerequiredIssueType
DTRMetricData.questionnaire.roleInteraction.roleextensibleUSCoreProviderRoleNucc
DTRMetricData.questionnaire.roleInteraction.roleActionextensibleMetricsInformationOrigins
DTRMetricData.coverageInfo.coveredrequiredCRDCoveredInfo
DTRMetricData.coverageInfo.paNeededrequiredCRDCoveragePaDetail
DTRMetricData.coverageInfo.docNeededrequiredCRDAdditionalDoc
DTRMetricData.coverageInfo.infoNeededrequiredCRDInformationNeeded

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DTRMetricData 0..*BaseDTR Metric Data
Instances of this logical model are not marked to be the target of a Reference
... source 1..1codeprovider-src | payer-src | DTRApp-src
Binding: Metric Source (required)
... sofApp 0..1urlURL of SMART on FHIR application
... providerId 1..1IdentifierIdentifier for the user initiating DTR
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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.

.... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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.

.... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... payerId 1..1IdentifierPayer receiving DTR request
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... assertionId 0..*stringUnique ID for order item
... docReason 0..*codewithpa | withclaim | withorder | retain-doc | OTH
Binding: CRD Coverage Information Documentation Reason Value Set (required)
... launchMode 0..1codecrdlaunch | relaunch | salaunch | cdexlaunch
Binding: Metric Launch Mode (required)
... orderItem 1..*CodeableConceptWhat was ordered
Binding: CRD Order Detail Codes Value Set (extensible)
... action 1..*BackboneElementActions the reporting system engaged in as part of the DTR session.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... actionDetail 1..1codelaunch | qpackage | mrquery | userresponse | nextq | storeqr
Binding: Metric Action (required)
.... requestTime 1..1instantTime action initiated
.... responseTime 0..1instantTime of action response
.... httpResponse 0..1integerHTTP response status code
.... questionnaire 0..1canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form)Associated Questionnaire
.... issue 0..*BackboneElementOperationOutcome info
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1codeError code
Binding: IssueType (required)
..... details 0..1CodeableConceptMore detailed error code
Binding: OperationOutcomeCodes (example)
... resources 0..*BackboneElementResource types accessed
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1codeKind of resource
Binding: ResourceType (required)
.... profile 0..1canonical(StructureDefinition)Solicited profile
.... count 1..1positiveIntNumber retrieved
... questionnaire 0..*BackboneElementQuestionnaire
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... reference 1..1canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form)This is the URL for the canonical questionnaire
.... adaptive 0..1booleanTrue if adaptive form
.... populated 0..1booleanWhether a pre-populated response was provided from payer
.... failure 0..*CodeableConceptQuestionnaire errors logged to payer
Binding: IssueType (required)
.... reviewPrior 0..1booleanTrue if user reviewed answers prior to final save
.... enabledQuestions 0..1positiveIntNumber of enabled questions
.... autoPopulated 0..1positiveIntNumber of questions autopopulated
.... roleInteraction 0..*BackboneElementRole specific interactions
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role 1..1CodeableConceptRole of information contributor
Binding: US Core Provider Role (NUCC) (extensible)
..... roleAction 1..1codeoverride | manual
Binding: Information Human Origins Value Set (extensible)
..... count 1..1positiveIntCount of combination of role and roleInteraction
.... elapsedTime 1..1timeCumulative user response time that questionnaire was active in session
... coverageInfo 0..*BackboneElementCoverage information
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... covered 0..1codecovered | not-covered | conditional
Binding: CRD Coverage Information Covered Value Set (required)
.... paNeeded 0..1codeauth-needed | no-auth | satisfied | performpa | conditional
Binding: CRD Coverage Information Prior Authorization Value Set (required)
.... docNeeded 0..1codeclinical | admin | both | conditional
Binding: CRD Coverage Information Additional Documentation Value Set (required)
.... infoNeeded 0..1codeperformer | location | timeframe | OTH
Binding: CRD Information Needed Value Set (required)
.... questionnaire 0..*BackboneElementQuestionnaire(s) returned
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... reference 1..1canonical(Questionnaire)Questionnaire url & version
..... adaptive 1..1booleanIs questionnaire adaptive?
..... response 1..1booleanPre-pop response provided?
.... assertionId 1..1stringId for coverage assertion
.... satisfiedId 0..1stringId if PA is satisfied
.... businessLine 0..1CodeableConceptE.g. MedicareAdvantage

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DTRMetricData.sourcerequiredMetricSource
DTRMetricData.providerId.userequiredIdentifierUse
DTRMetricData.providerId.typeextensibleIdentifier Type Codes
DTRMetricData.groupId.userequiredIdentifierUse
DTRMetricData.groupId.typeextensibleIdentifier Type Codes
DTRMetricData.payerId.userequiredIdentifierUse
DTRMetricData.payerId.typeextensibleIdentifier Type Codes
DTRMetricData.docReasonrequiredCRDDocReason
DTRMetricData.launchModerequiredMetricLaunchMode
DTRMetricData.orderItemextensibleMetricOrderDetail
DTRMetricData.action.actionDetailrequiredMetricAction
DTRMetricData.action.issue.coderequiredIssueType
DTRMetricData.action.issue.detailsexampleOperationOutcomeCodes
DTRMetricData.resources.typerequiredResourceType
DTRMetricData.questionnaire.failurerequiredIssueType
DTRMetricData.questionnaire.roleInteraction.roleextensibleUSCoreProviderRoleNucc
DTRMetricData.questionnaire.roleInteraction.roleActionextensibleMetricsInformationOrigins
DTRMetricData.coverageInfo.coveredrequiredCRDCoveredInfo
DTRMetricData.coverageInfo.paNeededrequiredCRDCoveragePaDetail
DTRMetricData.coverageInfo.docNeededrequiredCRDAdditionalDoc
DTRMetricData.coverageInfo.infoNeededrequiredCRDInformationNeeded

This structure is derived from Base

 

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