This page is part of the Documentation Templates and Rules (v2.1.0: STU 2.1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/DTRMetricData | Version: 2.1.0 | |||
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.
Purpose:
This logical model is NOT a FHIR data structure for information exchange. Instead, it is a 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':
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DTRMetricData | 0..* | Base | DTR Metric Data Instances of this logical model are not marked to be the target of a Reference | |
source | 1..1 | code | provider-src | payer-src | DTRApp-src Binding: Metric Source (required) | |
sofApp | 0..1 | url | URL of SMART on FHIR application | |
providerId | 1..1 | Identifier | Identifier for the user initiating DTR ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
type | Σ | 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. ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://hl7.org/fhir/sid/us-npi |
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
groupId | 1..1 | Identifier | Identifier for the healthcare organization initiating DTR ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
type | Σ | 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. ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://hl7.org/fhir/sid/us-npi |
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
payerId | 1..1 | Identifier | Payer receiving DTR request ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
type | Σ | 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. ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
assertionId | 0..* | string | Unique ID for order item | |
docReason | 0..* | code | withpa | withclaim | withorder | retain-doc | OTH Binding: CRD Coverage Information Documentation Reason Value Set (required) | |
launchMode | 0..1 | code | crdlaunch | relaunch | salaunch | cdexlaunch Binding: Metric Launch Mode (required) | |
orderItem | 1..* | CodeableConcept | What was ordered Binding: CRD Order Detail Codes Value Set (extensible) | |
action | 1..* | BackboneElement | Actions the reporting system engaged in as part of the DTR session. ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
actionDetail | 1..1 | code | launch | qpackage | mrquery | userresponse | nextq | storeqr Binding: Metric Action (required) | |
requestTime | 1..1 | instant | Time action initiated | |
responseTime | 0..1 | instant | Time of action response | |
httpResponse | 0..1 | integer | HTTP response status code | |
questionnaire | 0..1 | canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form) | Associated Questionnaire | |
issue | 0..* | BackboneElement | OperationOutcome info ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
code | 1..1 | code | Error code Binding: IssueType (required) | |
details | 0..1 | CodeableConcept | More detailed error code Binding: OperationOutcomeCodes (example) | |
resources | 0..* | BackboneElement | Resource types accessed ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
type | 1..1 | code | Kind of resource Binding: ResourceType (required) | |
profile | 0..1 | canonical(StructureDefinition) | Solicited profile | |
count | 1..1 | positiveInt | Number retrieved | |
questionnaire | 0..* | BackboneElement | Questionnaire ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
reference | 1..1 | canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form) | This is the URL for the canonical questionnaire | |
adaptive | 0..1 | boolean | True if adaptive form | |
populated | 0..1 | boolean | Whether a pre-populated response was provided from payer | |
failure | 0..* | CodeableConcept | Questionnaire errors logged to payer Binding: IssueType (required) | |
reviewPrior | 0..1 | boolean | True if user reviewed answers prior to final save | |
enabledQuestions | 0..1 | positiveInt | Number of enabled questions | |
autoPopulated | 0..1 | positiveInt | Number of questions autopopulated | |
roleInteraction | 0..* | BackboneElement | Role specific interactions ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
role | 1..1 | CodeableConcept | Role of information contributor Binding: US Core Provider Role (NUCC) (extensible) | |
roleAction | 1..1 | code | override | manual Binding: Information Human Origins Value Set (extensible) | |
count | 1..1 | positiveInt | Count of combination of role and roleInteraction | |
elapsedTime | 1..1 | time | Cumulative user response time that questionnaire was active in session | |
coverageInfo | 0..* | BackboneElement | Coverage information ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
covered | 0..1 | code | covered | not-covered | conditional Binding: CRD Coverage Information Covered Value Set (required) | |
paNeeded | 0..1 | code | auth-needed | no-auth | satisfied | performpa | conditional Binding: CRD Coverage Information Prior Authorization Value Set (required) | |
docNeeded | 0..1 | code | clinical | admin | both | conditional Binding: CRD Coverage Information Additional Documentation Value Set (required) | |
infoNeeded | 0..1 | code | performer | location | timeframe | OTH Binding: CRD Information Needed Value Set (required) | |
questionnaire | 0..* | BackboneElement | Questionnaire(s) returned ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
reference | 1..1 | canonical(Questionnaire) | Questionnaire url & version | |
adaptive | 1..1 | boolean | Is questionnaire adaptive? | |
response | 1..1 | boolean | Pre-pop response provided? | |
assertionId | 1..1 | string | Id for coverage assertion | |
satisfiedId | 0..1 | string | Id if PA is satisfied | |
businessLine | 0..1 | CodeableConcept | e.g., MedicareAdvantage | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DTRMetricData.source | required | MetricSourcehttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-Source from this IG | |
DTRMetricData.providerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
DTRMetricData.providerId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DTRMetricData.groupId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
DTRMetricData.groupId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DTRMetricData.payerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
DTRMetricData.payerId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DTRMetricData.docReason | required | CRDDocReasonhttp://hl7.org/fhir/us/davinci-crd/ValueSet/DocReason | |
DTRMetricData.launchMode | required | MetricLaunchModehttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-launchmode from this IG | |
DTRMetricData.orderItem | extensible | MetricOrderDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetail | |
DTRMetricData.action.actionDetail | required | MetricActionhttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-Action from this IG | |
DTRMetricData.action.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type from the FHIR Standard | |
DTRMetricData.action.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcome from the FHIR Standard | |
DTRMetricData.resources.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
DTRMetricData.questionnaire.failure | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type from the FHIR Standard | |
DTRMetricData.questionnaire.roleInteraction.role | extensible | USCoreProviderRoleNucchttp://hl7.org/fhir/us/core/ValueSet/us-core-provider-role | |
DTRMetricData.questionnaire.roleInteraction.roleAction | extensible | MetricsInformationOriginshttp://hl7.org/fhir/us/davinci-dtr/ValueSet/MetricsinformationOrigins from this IG | |
DTRMetricData.coverageInfo.covered | required | CRDCoveredInfohttp://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfo | |
DTRMetricData.coverageInfo.paNeeded | required | CRDCoveragePaDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetail | |
DTRMetricData.coverageInfo.docNeeded | required | CRDAdditionalDochttp://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentation | |
DTRMetricData.coverageInfo.infoNeeded | required | CRDInformationNeededhttp://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeeded |
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DTRMetricData | 0..* | Base | DTR Metric Data Instances of this logical model are not marked to be the target of a Reference | |
source | 1..1 | code | provider-src | payer-src | DTRApp-src Binding: Metric Source (required) | |
sofApp | 0..1 | url | URL of SMART on FHIR application | |
providerId | 1..1 | Identifier | Identifier for the user initiating DTR | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi | |
value | 1..1 | string | The value that is unique | |
groupId | 1..1 | Identifier | Identifier for the healthcare organization initiating DTR | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi | |
value | 1..1 | string | The value that is unique | |
payerId | 1..1 | Identifier | Payer receiving DTR request | |
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
assertionId | 0..* | string | Unique ID for order item | |
docReason | 0..* | code | withpa | withclaim | withorder | retain-doc | OTH Binding: CRD Coverage Information Documentation Reason Value Set (required) | |
launchMode | 0..1 | code | crdlaunch | relaunch | salaunch | cdexlaunch Binding: Metric Launch Mode (required) | |
orderItem | 1..* | CodeableConcept | What was ordered Binding: CRD Order Detail Codes Value Set (extensible) | |
action | 1..* | BackboneElement | Actions the reporting system engaged in as part of the DTR session. | |
actionDetail | 1..1 | code | launch | qpackage | mrquery | userresponse | nextq | storeqr Binding: Metric Action (required) | |
requestTime | 1..1 | instant | Time action initiated | |
responseTime | 0..1 | instant | Time of action response | |
httpResponse | 0..1 | integer | HTTP response status code | |
questionnaire | 0..1 | canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form) | Associated Questionnaire | |
issue | 0..* | BackboneElement | OperationOutcome info | |
code | 1..1 | code | Error code Binding: IssueType (required) | |
details | 0..1 | CodeableConcept | More detailed error code Binding: OperationOutcomeCodes (example) | |
resources | 0..* | BackboneElement | Resource types accessed | |
type | 1..1 | code | Kind of resource Binding: ResourceType (required) | |
profile | 0..1 | canonical(StructureDefinition) | Solicited profile | |
count | 1..1 | positiveInt | Number retrieved | |
questionnaire | 0..* | BackboneElement | Questionnaire | |
reference | 1..1 | canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form) | This is the URL for the canonical questionnaire | |
adaptive | 0..1 | boolean | True if adaptive form | |
populated | 0..1 | boolean | Whether a pre-populated response was provided from payer | |
failure | 0..* | CodeableConcept | Questionnaire errors logged to payer Binding: IssueType (required) | |
reviewPrior | 0..1 | boolean | True if user reviewed answers prior to final save | |
enabledQuestions | 0..1 | positiveInt | Number of enabled questions | |
autoPopulated | 0..1 | positiveInt | Number of questions autopopulated | |
roleInteraction | 0..* | BackboneElement | Role specific interactions | |
role | 1..1 | CodeableConcept | Role of information contributor Binding: US Core Provider Role (NUCC) (extensible) | |
roleAction | 1..1 | code | override | manual Binding: Information Human Origins Value Set (extensible) | |
count | 1..1 | positiveInt | Count of combination of role and roleInteraction | |
elapsedTime | 1..1 | time | Cumulative user response time that questionnaire was active in session | |
coverageInfo | 0..* | BackboneElement | Coverage information | |
covered | 0..1 | code | covered | not-covered | conditional Binding: CRD Coverage Information Covered Value Set (required) | |
paNeeded | 0..1 | code | auth-needed | no-auth | satisfied | performpa | conditional Binding: CRD Coverage Information Prior Authorization Value Set (required) | |
docNeeded | 0..1 | code | clinical | admin | both | conditional Binding: CRD Coverage Information Additional Documentation Value Set (required) | |
infoNeeded | 0..1 | code | performer | location | timeframe | OTH Binding: CRD Information Needed Value Set (required) | |
questionnaire | 0..* | BackboneElement | Questionnaire(s) returned | |
reference | 1..1 | canonical(Questionnaire) | Questionnaire url & version | |
adaptive | 1..1 | boolean | Is questionnaire adaptive? | |
response | 1..1 | boolean | Pre-pop response provided? | |
assertionId | 1..1 | string | Id for coverage assertion | |
satisfiedId | 0..1 | string | Id if PA is satisfied | |
businessLine | 0..1 | CodeableConcept | e.g., MedicareAdvantage | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DTRMetricData.source | required | MetricSourcehttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-Source from this IG | |
DTRMetricData.docReason | required | CRDDocReasonhttp://hl7.org/fhir/us/davinci-crd/ValueSet/DocReason | |
DTRMetricData.launchMode | required | MetricLaunchModehttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-launchmode from this IG | |
DTRMetricData.orderItem | extensible | MetricOrderDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetail | |
DTRMetricData.action.actionDetail | required | MetricActionhttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-Action from this IG | |
DTRMetricData.action.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type from the FHIR Standard | |
DTRMetricData.action.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcome from the FHIR Standard | |
DTRMetricData.resources.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
DTRMetricData.questionnaire.failure | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type from the FHIR Standard | |
DTRMetricData.questionnaire.roleInteraction.role | extensible | USCoreProviderRoleNucchttp://hl7.org/fhir/us/core/ValueSet/us-core-provider-role | |
DTRMetricData.questionnaire.roleInteraction.roleAction | extensible | MetricsInformationOriginshttp://hl7.org/fhir/us/davinci-dtr/ValueSet/MetricsinformationOrigins from this IG | |
DTRMetricData.coverageInfo.covered | required | CRDCoveredInfohttp://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfo | |
DTRMetricData.coverageInfo.paNeeded | required | CRDCoveragePaDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetail | |
DTRMetricData.coverageInfo.docNeeded | required | CRDAdditionalDochttp://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentation | |
DTRMetricData.coverageInfo.infoNeeded | required | CRDInformationNeededhttp://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeeded |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DTRMetricData | 0..* | Base | DTR Metric Data Instances of this logical model are not marked to be the target of a Reference | |
source | 1..1 | code | provider-src | payer-src | DTRApp-src Binding: Metric Source (required) | |
sofApp | 0..1 | url | URL of SMART on FHIR application | |
providerId | 1..1 | Identifier | Identifier for the user initiating DTR | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 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. |
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
groupId | 1..1 | Identifier | Identifier for the healthcare organization initiating DTR | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 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. |
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
payerId | 1..1 | Identifier | Payer receiving DTR request | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 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. |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
assertionId | 0..* | string | Unique ID for order item | |
docReason | 0..* | code | withpa | withclaim | withorder | retain-doc | OTH Binding: CRD Coverage Information Documentation Reason Value Set (required) | |
launchMode | 0..1 | code | crdlaunch | relaunch | salaunch | cdexlaunch Binding: Metric Launch Mode (required) | |
orderItem | 1..* | CodeableConcept | What was ordered Binding: CRD Order Detail Codes Value Set (extensible) | |
action | 1..* | BackboneElement | Actions the reporting system engaged in as part of the DTR session. | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionDetail | 1..1 | code | launch | qpackage | mrquery | userresponse | nextq | storeqr Binding: Metric Action (required) | |
requestTime | 1..1 | instant | Time action initiated | |
responseTime | 0..1 | instant | Time of action response | |
httpResponse | 0..1 | integer | HTTP response status code | |
questionnaire | 0..1 | canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form) | Associated Questionnaire | |
issue | 0..* | BackboneElement | OperationOutcome info | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | code | Error code Binding: IssueType (required) | |
details | 0..1 | CodeableConcept | More detailed error code Binding: OperationOutcomeCodes (example) | |
resources | 0..* | BackboneElement | Resource types accessed | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | code | Kind of resource Binding: ResourceType (required) | |
profile | 0..1 | canonical(StructureDefinition) | Solicited profile | |
count | 1..1 | positiveInt | Number retrieved | |
questionnaire | 0..* | BackboneElement | Questionnaire | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
reference | 1..1 | canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form) | This is the URL for the canonical questionnaire | |
adaptive | 0..1 | boolean | True if adaptive form | |
populated | 0..1 | boolean | Whether a pre-populated response was provided from payer | |
failure | 0..* | CodeableConcept | Questionnaire errors logged to payer Binding: IssueType (required) | |
reviewPrior | 0..1 | boolean | True if user reviewed answers prior to final save | |
enabledQuestions | 0..1 | positiveInt | Number of enabled questions | |
autoPopulated | 0..1 | positiveInt | Number of questions autopopulated | |
roleInteraction | 0..* | BackboneElement | Role specific interactions | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | 1..1 | CodeableConcept | Role of information contributor Binding: US Core Provider Role (NUCC) (extensible) | |
roleAction | 1..1 | code | override | manual Binding: Information Human Origins Value Set (extensible) | |
count | 1..1 | positiveInt | Count of combination of role and roleInteraction | |
elapsedTime | 1..1 | time | Cumulative user response time that questionnaire was active in session | |
coverageInfo | 0..* | BackboneElement | Coverage information | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
covered | 0..1 | code | covered | not-covered | conditional Binding: CRD Coverage Information Covered Value Set (required) | |
paNeeded | 0..1 | code | auth-needed | no-auth | satisfied | performpa | conditional Binding: CRD Coverage Information Prior Authorization Value Set (required) | |
docNeeded | 0..1 | code | clinical | admin | both | conditional Binding: CRD Coverage Information Additional Documentation Value Set (required) | |
infoNeeded | 0..1 | code | performer | location | timeframe | OTH Binding: CRD Information Needed Value Set (required) | |
questionnaire | 0..* | BackboneElement | Questionnaire(s) returned | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
reference | 1..1 | canonical(Questionnaire) | Questionnaire url & version | |
adaptive | 1..1 | boolean | Is questionnaire adaptive? | |
response | 1..1 | boolean | Pre-pop response provided? | |
assertionId | 1..1 | string | Id for coverage assertion | |
satisfiedId | 0..1 | string | Id if PA is satisfied | |
businessLine | 0..1 | CodeableConcept | e.g., MedicareAdvantage | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DTRMetricData.source | required | MetricSourcehttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-Source from this IG | |
DTRMetricData.providerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
DTRMetricData.providerId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DTRMetricData.groupId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
DTRMetricData.groupId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DTRMetricData.payerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
DTRMetricData.payerId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DTRMetricData.docReason | required | CRDDocReasonhttp://hl7.org/fhir/us/davinci-crd/ValueSet/DocReason | |
DTRMetricData.launchMode | required | MetricLaunchModehttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-launchmode from this IG | |
DTRMetricData.orderItem | extensible | MetricOrderDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetail | |
DTRMetricData.action.actionDetail | required | MetricActionhttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-Action from this IG | |
DTRMetricData.action.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type from the FHIR Standard | |
DTRMetricData.action.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcome from the FHIR Standard | |
DTRMetricData.resources.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
DTRMetricData.questionnaire.failure | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type from the FHIR Standard | |
DTRMetricData.questionnaire.roleInteraction.role | extensible | USCoreProviderRoleNucchttp://hl7.org/fhir/us/core/ValueSet/us-core-provider-role | |
DTRMetricData.questionnaire.roleInteraction.roleAction | extensible | MetricsInformationOriginshttp://hl7.org/fhir/us/davinci-dtr/ValueSet/MetricsinformationOrigins from this IG | |
DTRMetricData.coverageInfo.covered | required | CRDCoveredInfohttp://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfo | |
DTRMetricData.coverageInfo.paNeeded | required | CRDCoveragePaDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetail | |
DTRMetricData.coverageInfo.docNeeded | required | CRDAdditionalDochttp://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentation | |
DTRMetricData.coverageInfo.infoNeeded | required | CRDInformationNeededhttp://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeeded |
This structure is derived from Base
Summary
Mandatory: 6 elements(20 nested mandatory elements)
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DTRMetricData | 0..* | Base | DTR Metric Data Instances of this logical model are not marked to be the target of a Reference | |
source | 1..1 | code | provider-src | payer-src | DTRApp-src Binding: Metric Source (required) | |
sofApp | 0..1 | url | URL of SMART on FHIR application | |
providerId | 1..1 | Identifier | Identifier for the user initiating DTR ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
type | Σ | 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. ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://hl7.org/fhir/sid/us-npi |
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
groupId | 1..1 | Identifier | Identifier for the healthcare organization initiating DTR ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
type | Σ | 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. ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://hl7.org/fhir/sid/us-npi |
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
payerId | 1..1 | Identifier | Payer receiving DTR request ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
type | Σ | 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. ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
assertionId | 0..* | string | Unique ID for order item | |
docReason | 0..* | code | withpa | withclaim | withorder | retain-doc | OTH Binding: CRD Coverage Information Documentation Reason Value Set (required) | |
launchMode | 0..1 | code | crdlaunch | relaunch | salaunch | cdexlaunch Binding: Metric Launch Mode (required) | |
orderItem | 1..* | CodeableConcept | What was ordered Binding: CRD Order Detail Codes Value Set (extensible) | |
action | 1..* | BackboneElement | Actions the reporting system engaged in as part of the DTR session. ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
actionDetail | 1..1 | code | launch | qpackage | mrquery | userresponse | nextq | storeqr Binding: Metric Action (required) | |
requestTime | 1..1 | instant | Time action initiated | |
responseTime | 0..1 | instant | Time of action response | |
httpResponse | 0..1 | integer | HTTP response status code | |
questionnaire | 0..1 | canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form) | Associated Questionnaire | |
issue | 0..* | BackboneElement | OperationOutcome info ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
code | 1..1 | code | Error code Binding: IssueType (required) | |
details | 0..1 | CodeableConcept | More detailed error code Binding: OperationOutcomeCodes (example) | |
resources | 0..* | BackboneElement | Resource types accessed ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
type | 1..1 | code | Kind of resource Binding: ResourceType (required) | |
profile | 0..1 | canonical(StructureDefinition) | Solicited profile | |
count | 1..1 | positiveInt | Number retrieved | |
questionnaire | 0..* | BackboneElement | Questionnaire ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
reference | 1..1 | canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form) | This is the URL for the canonical questionnaire | |
adaptive | 0..1 | boolean | True if adaptive form | |
populated | 0..1 | boolean | Whether a pre-populated response was provided from payer | |
failure | 0..* | CodeableConcept | Questionnaire errors logged to payer Binding: IssueType (required) | |
reviewPrior | 0..1 | boolean | True if user reviewed answers prior to final save | |
enabledQuestions | 0..1 | positiveInt | Number of enabled questions | |
autoPopulated | 0..1 | positiveInt | Number of questions autopopulated | |
roleInteraction | 0..* | BackboneElement | Role specific interactions ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
role | 1..1 | CodeableConcept | Role of information contributor Binding: US Core Provider Role (NUCC) (extensible) | |
roleAction | 1..1 | code | override | manual Binding: Information Human Origins Value Set (extensible) | |
count | 1..1 | positiveInt | Count of combination of role and roleInteraction | |
elapsedTime | 1..1 | time | Cumulative user response time that questionnaire was active in session | |
coverageInfo | 0..* | BackboneElement | Coverage information ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
covered | 0..1 | code | covered | not-covered | conditional Binding: CRD Coverage Information Covered Value Set (required) | |
paNeeded | 0..1 | code | auth-needed | no-auth | satisfied | performpa | conditional Binding: CRD Coverage Information Prior Authorization Value Set (required) | |
docNeeded | 0..1 | code | clinical | admin | both | conditional Binding: CRD Coverage Information Additional Documentation Value Set (required) | |
infoNeeded | 0..1 | code | performer | location | timeframe | OTH Binding: CRD Information Needed Value Set (required) | |
questionnaire | 0..* | BackboneElement | Questionnaire(s) returned ele-1: All FHIR elements must have a @value or children | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
reference | 1..1 | canonical(Questionnaire) | Questionnaire url & version | |
adaptive | 1..1 | boolean | Is questionnaire adaptive? | |
response | 1..1 | boolean | Pre-pop response provided? | |
assertionId | 1..1 | string | Id for coverage assertion | |
satisfiedId | 0..1 | string | Id if PA is satisfied | |
businessLine | 0..1 | CodeableConcept | e.g., MedicareAdvantage | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DTRMetricData.source | required | MetricSourcehttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-Source from this IG | |
DTRMetricData.providerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
DTRMetricData.providerId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DTRMetricData.groupId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
DTRMetricData.groupId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DTRMetricData.payerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
DTRMetricData.payerId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DTRMetricData.docReason | required | CRDDocReasonhttp://hl7.org/fhir/us/davinci-crd/ValueSet/DocReason | |
DTRMetricData.launchMode | required | MetricLaunchModehttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-launchmode from this IG | |
DTRMetricData.orderItem | extensible | MetricOrderDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetail | |
DTRMetricData.action.actionDetail | required | MetricActionhttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-Action from this IG | |
DTRMetricData.action.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type from the FHIR Standard | |
DTRMetricData.action.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcome from the FHIR Standard | |
DTRMetricData.resources.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
DTRMetricData.questionnaire.failure | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type from the FHIR Standard | |
DTRMetricData.questionnaire.roleInteraction.role | extensible | USCoreProviderRoleNucchttp://hl7.org/fhir/us/core/ValueSet/us-core-provider-role | |
DTRMetricData.questionnaire.roleInteraction.roleAction | extensible | MetricsInformationOriginshttp://hl7.org/fhir/us/davinci-dtr/ValueSet/MetricsinformationOrigins from this IG | |
DTRMetricData.coverageInfo.covered | required | CRDCoveredInfohttp://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfo | |
DTRMetricData.coverageInfo.paNeeded | required | CRDCoveragePaDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetail | |
DTRMetricData.coverageInfo.docNeeded | required | CRDAdditionalDochttp://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentation | |
DTRMetricData.coverageInfo.infoNeeded | required | CRDInformationNeededhttp://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeeded |
Differential View
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DTRMetricData | 0..* | Base | DTR Metric Data Instances of this logical model are not marked to be the target of a Reference | |
source | 1..1 | code | provider-src | payer-src | DTRApp-src Binding: Metric Source (required) | |
sofApp | 0..1 | url | URL of SMART on FHIR application | |
providerId | 1..1 | Identifier | Identifier for the user initiating DTR | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi | |
value | 1..1 | string | The value that is unique | |
groupId | 1..1 | Identifier | Identifier for the healthcare organization initiating DTR | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi | |
value | 1..1 | string | The value that is unique | |
payerId | 1..1 | Identifier | Payer receiving DTR request | |
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
assertionId | 0..* | string | Unique ID for order item | |
docReason | 0..* | code | withpa | withclaim | withorder | retain-doc | OTH Binding: CRD Coverage Information Documentation Reason Value Set (required) | |
launchMode | 0..1 | code | crdlaunch | relaunch | salaunch | cdexlaunch Binding: Metric Launch Mode (required) | |
orderItem | 1..* | CodeableConcept | What was ordered Binding: CRD Order Detail Codes Value Set (extensible) | |
action | 1..* | BackboneElement | Actions the reporting system engaged in as part of the DTR session. | |
actionDetail | 1..1 | code | launch | qpackage | mrquery | userresponse | nextq | storeqr Binding: Metric Action (required) | |
requestTime | 1..1 | instant | Time action initiated | |
responseTime | 0..1 | instant | Time of action response | |
httpResponse | 0..1 | integer | HTTP response status code | |
questionnaire | 0..1 | canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form) | Associated Questionnaire | |
issue | 0..* | BackboneElement | OperationOutcome info | |
code | 1..1 | code | Error code Binding: IssueType (required) | |
details | 0..1 | CodeableConcept | More detailed error code Binding: OperationOutcomeCodes (example) | |
resources | 0..* | BackboneElement | Resource types accessed | |
type | 1..1 | code | Kind of resource Binding: ResourceType (required) | |
profile | 0..1 | canonical(StructureDefinition) | Solicited profile | |
count | 1..1 | positiveInt | Number retrieved | |
questionnaire | 0..* | BackboneElement | Questionnaire | |
reference | 1..1 | canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form) | This is the URL for the canonical questionnaire | |
adaptive | 0..1 | boolean | True if adaptive form | |
populated | 0..1 | boolean | Whether a pre-populated response was provided from payer | |
failure | 0..* | CodeableConcept | Questionnaire errors logged to payer Binding: IssueType (required) | |
reviewPrior | 0..1 | boolean | True if user reviewed answers prior to final save | |
enabledQuestions | 0..1 | positiveInt | Number of enabled questions | |
autoPopulated | 0..1 | positiveInt | Number of questions autopopulated | |
roleInteraction | 0..* | BackboneElement | Role specific interactions | |
role | 1..1 | CodeableConcept | Role of information contributor Binding: US Core Provider Role (NUCC) (extensible) | |
roleAction | 1..1 | code | override | manual Binding: Information Human Origins Value Set (extensible) | |
count | 1..1 | positiveInt | Count of combination of role and roleInteraction | |
elapsedTime | 1..1 | time | Cumulative user response time that questionnaire was active in session | |
coverageInfo | 0..* | BackboneElement | Coverage information | |
covered | 0..1 | code | covered | not-covered | conditional Binding: CRD Coverage Information Covered Value Set (required) | |
paNeeded | 0..1 | code | auth-needed | no-auth | satisfied | performpa | conditional Binding: CRD Coverage Information Prior Authorization Value Set (required) | |
docNeeded | 0..1 | code | clinical | admin | both | conditional Binding: CRD Coverage Information Additional Documentation Value Set (required) | |
infoNeeded | 0..1 | code | performer | location | timeframe | OTH Binding: CRD Information Needed Value Set (required) | |
questionnaire | 0..* | BackboneElement | Questionnaire(s) returned | |
reference | 1..1 | canonical(Questionnaire) | Questionnaire url & version | |
adaptive | 1..1 | boolean | Is questionnaire adaptive? | |
response | 1..1 | boolean | Pre-pop response provided? | |
assertionId | 1..1 | string | Id for coverage assertion | |
satisfiedId | 0..1 | string | Id if PA is satisfied | |
businessLine | 0..1 | CodeableConcept | e.g., MedicareAdvantage | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DTRMetricData.source | required | MetricSourcehttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-Source from this IG | |
DTRMetricData.docReason | required | CRDDocReasonhttp://hl7.org/fhir/us/davinci-crd/ValueSet/DocReason | |
DTRMetricData.launchMode | required | MetricLaunchModehttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-launchmode from this IG | |
DTRMetricData.orderItem | extensible | MetricOrderDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetail | |
DTRMetricData.action.actionDetail | required | MetricActionhttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-Action from this IG | |
DTRMetricData.action.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type from the FHIR Standard | |
DTRMetricData.action.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcome from the FHIR Standard | |
DTRMetricData.resources.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
DTRMetricData.questionnaire.failure | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type from the FHIR Standard | |
DTRMetricData.questionnaire.roleInteraction.role | extensible | USCoreProviderRoleNucchttp://hl7.org/fhir/us/core/ValueSet/us-core-provider-role | |
DTRMetricData.questionnaire.roleInteraction.roleAction | extensible | MetricsInformationOriginshttp://hl7.org/fhir/us/davinci-dtr/ValueSet/MetricsinformationOrigins from this IG | |
DTRMetricData.coverageInfo.covered | required | CRDCoveredInfohttp://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfo | |
DTRMetricData.coverageInfo.paNeeded | required | CRDCoveragePaDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetail | |
DTRMetricData.coverageInfo.docNeeded | required | CRDAdditionalDochttp://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentation | |
DTRMetricData.coverageInfo.infoNeeded | required | CRDInformationNeededhttp://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeeded |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DTRMetricData | 0..* | Base | DTR Metric Data Instances of this logical model are not marked to be the target of a Reference | |
source | 1..1 | code | provider-src | payer-src | DTRApp-src Binding: Metric Source (required) | |
sofApp | 0..1 | url | URL of SMART on FHIR application | |
providerId | 1..1 | Identifier | Identifier for the user initiating DTR | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 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. |
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
groupId | 1..1 | Identifier | Identifier for the healthcare organization initiating DTR | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 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. |
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
payerId | 1..1 | Identifier | Payer receiving DTR request | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 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. |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
assertionId | 0..* | string | Unique ID for order item | |
docReason | 0..* | code | withpa | withclaim | withorder | retain-doc | OTH Binding: CRD Coverage Information Documentation Reason Value Set (required) | |
launchMode | 0..1 | code | crdlaunch | relaunch | salaunch | cdexlaunch Binding: Metric Launch Mode (required) | |
orderItem | 1..* | CodeableConcept | What was ordered Binding: CRD Order Detail Codes Value Set (extensible) | |
action | 1..* | BackboneElement | Actions the reporting system engaged in as part of the DTR session. | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actionDetail | 1..1 | code | launch | qpackage | mrquery | userresponse | nextq | storeqr Binding: Metric Action (required) | |
requestTime | 1..1 | instant | Time action initiated | |
responseTime | 0..1 | instant | Time of action response | |
httpResponse | 0..1 | integer | HTTP response status code | |
questionnaire | 0..1 | canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form) | Associated Questionnaire | |
issue | 0..* | BackboneElement | OperationOutcome info | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 1..1 | code | Error code Binding: IssueType (required) | |
details | 0..1 | CodeableConcept | More detailed error code Binding: OperationOutcomeCodes (example) | |
resources | 0..* | BackboneElement | Resource types accessed | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | code | Kind of resource Binding: ResourceType (required) | |
profile | 0..1 | canonical(StructureDefinition) | Solicited profile | |
count | 1..1 | positiveInt | Number retrieved | |
questionnaire | 0..* | BackboneElement | Questionnaire | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
reference | 1..1 | canonical(DTR Standard Questionnaire | DTR Questionnaire for adaptive form) | This is the URL for the canonical questionnaire | |
adaptive | 0..1 | boolean | True if adaptive form | |
populated | 0..1 | boolean | Whether a pre-populated response was provided from payer | |
failure | 0..* | CodeableConcept | Questionnaire errors logged to payer Binding: IssueType (required) | |
reviewPrior | 0..1 | boolean | True if user reviewed answers prior to final save | |
enabledQuestions | 0..1 | positiveInt | Number of enabled questions | |
autoPopulated | 0..1 | positiveInt | Number of questions autopopulated | |
roleInteraction | 0..* | BackboneElement | Role specific interactions | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | 1..1 | CodeableConcept | Role of information contributor Binding: US Core Provider Role (NUCC) (extensible) | |
roleAction | 1..1 | code | override | manual Binding: Information Human Origins Value Set (extensible) | |
count | 1..1 | positiveInt | Count of combination of role and roleInteraction | |
elapsedTime | 1..1 | time | Cumulative user response time that questionnaire was active in session | |
coverageInfo | 0..* | BackboneElement | Coverage information | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
covered | 0..1 | code | covered | not-covered | conditional Binding: CRD Coverage Information Covered Value Set (required) | |
paNeeded | 0..1 | code | auth-needed | no-auth | satisfied | performpa | conditional Binding: CRD Coverage Information Prior Authorization Value Set (required) | |
docNeeded | 0..1 | code | clinical | admin | both | conditional Binding: CRD Coverage Information Additional Documentation Value Set (required) | |
infoNeeded | 0..1 | code | performer | location | timeframe | OTH Binding: CRD Information Needed Value Set (required) | |
questionnaire | 0..* | BackboneElement | Questionnaire(s) returned | |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
reference | 1..1 | canonical(Questionnaire) | Questionnaire url & version | |
adaptive | 1..1 | boolean | Is questionnaire adaptive? | |
response | 1..1 | boolean | Pre-pop response provided? | |
assertionId | 1..1 | string | Id for coverage assertion | |
satisfiedId | 0..1 | string | Id if PA is satisfied | |
businessLine | 0..1 | CodeableConcept | e.g., MedicareAdvantage | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DTRMetricData.source | required | MetricSourcehttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-Source from this IG | |
DTRMetricData.providerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
DTRMetricData.providerId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DTRMetricData.groupId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
DTRMetricData.groupId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DTRMetricData.payerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
DTRMetricData.payerId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
DTRMetricData.docReason | required | CRDDocReasonhttp://hl7.org/fhir/us/davinci-crd/ValueSet/DocReason | |
DTRMetricData.launchMode | required | MetricLaunchModehttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-launchmode from this IG | |
DTRMetricData.orderItem | extensible | MetricOrderDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetail | |
DTRMetricData.action.actionDetail | required | MetricActionhttp://hl7.org/fhir/us/davinci-dtr/ValueSet/metric-Action from this IG | |
DTRMetricData.action.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type from the FHIR Standard | |
DTRMetricData.action.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcome from the FHIR Standard | |
DTRMetricData.resources.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
DTRMetricData.questionnaire.failure | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-type from the FHIR Standard | |
DTRMetricData.questionnaire.roleInteraction.role | extensible | USCoreProviderRoleNucchttp://hl7.org/fhir/us/core/ValueSet/us-core-provider-role | |
DTRMetricData.questionnaire.roleInteraction.roleAction | extensible | MetricsInformationOriginshttp://hl7.org/fhir/us/davinci-dtr/ValueSet/MetricsinformationOrigins from this IG | |
DTRMetricData.coverageInfo.covered | required | CRDCoveredInfohttp://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfo | |
DTRMetricData.coverageInfo.paNeeded | required | CRDCoveragePaDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetail | |
DTRMetricData.coverageInfo.docNeeded | required | CRDAdditionalDochttp://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentation | |
DTRMetricData.coverageInfo.infoNeeded | required | CRDInformationNeededhttp://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeeded |
This structure is derived from Base
Summary
Mandatory: 6 elements(20 nested mandatory elements)
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel
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 |