Da Vinci - Coverage Requirements Discovery
2.1.0 - STU 2.1
Da Vinci - Coverage Requirements Discovery
2.1.0 - STU 2.1
Da Vinci - Coverage Requirements Discovery, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-crd/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDMetricData | Version: 2.1.0 | |||
| Standards status: Informative | Maturity Level: 1 | Computable Name: CRDMetricData | ||
A logical model describing the information that should be captured by CRD implementers about every CRD invocation to support measures evaluating CRD 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 CRD transaction. 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 CRD exchanges.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CRDMetricData |
0..* | Base | CRD 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 Binding: CRD Metric Data Source Value Set (required) | |
| hookInstance |
1..1 | string | Unique hook invocation id | |
| hookType |
1..1 | code | order-select | order-sign + Binding: CDS Hook Types Value Set (extensible) | |
  providerId |
1..1 | Identifier | User invoking hook | |
 system |
0..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 | Healthcare org of user | |
| system |
0..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 hook | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| requestTime |
1..1 | instant | Time hook initiated | |
| responseTime |
0..1 | instant | Time of hook response | |
| httpResponse |
1..1 | positiveInt | e.g. 200 | |
| 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) | |
| tokenUse |
0..1 | code | used | not-used | rejected Binding: CRD Metric Token Use (example) | |
| orderDetail |
0..* | CodeableConcept | Service or product code(s) Binding: CRD Order Detail Codes Value Set (extensible) | |
| 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 | |
| prefetch |
0..1 | boolean | Retrieved by prefetch? | |
 response |
0..* | BackboneElement | Returned card/system action | |
 type |
0..1 | code | Type of CRD card Binding: CRD Card Types Value Set (required) | |
| focus |
0..* | code | Resource tied to card | |
| engagement |
0..1 | code | ignore | accept | override | |
| 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 + Binding: CRD Coverage Information Prior Authorization Value Set (required) | |
| docNeeded |
0..1 | code | no-doc | clinical | admin | both + Binding: CRD Coverage Information Additional Documentation Value Set (required) | |
| infoNeeded |
0..1 | code | performer | location | timeframe 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 |
| CRDMetricData.source | required | MetricDataSourcehttp://hl7.org/fhir/us/davinci-crd/ValueSet/metricDataSourcefrom this IG | |
| CRDMetricData.hookType | extensible | CDSHookTypehttp://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookTypefrom this IG | |
| CRDMetricData.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-typefrom the FHIR Standard | |
| CRDMetricData.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard | |
| CRDMetricData.tokenUse | example | MetricTokenUsehttp://hl7.org/fhir/us/davinci-crd/ValueSet/metricTokenUsefrom this IG | |
| CRDMetricData.orderDetail | extensible | MetricOrderDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetailfrom this IG | |
| CRDMetricData.resources.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| CRDMetricData.response.type | required | CRDCardTypehttp://hl7.org/fhir/us/davinci-crd/ValueSet/cardTypefrom this IG | |
| CRDMetricData.response.coverageInfo.covered | required | CRDCoveredInfohttp://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfofrom this IG | |
| CRDMetricData.response.coverageInfo.paNeeded | required | CRDCoveragePaDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetailfrom this IG | |
| CRDMetricData.response.coverageInfo.docNeeded | required | CRDAdditionalDochttp://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentationfrom this IG | |
| CRDMetricData.response.coverageInfo.infoNeeded | required | CRDInformationNeededhttp://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeededfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CRDMetricData |
0..* | Base | CRD 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 Binding: CRD Metric Data Source Value Set (required) | |
| hookInstance |
1..1 | string | Unique hook invocation id | |
| hookType |
1..1 | code | order-select | order-sign + Binding: CDS Hook Types Value Set (extensible) | |
| providerId |
1..1 | Identifier | User invoking hook | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 0..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 |
| groupId |
1..1 | Identifier | Healthcare org of user | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 0..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 |
| payerId |
1..1 | Identifier | Payer receiving hook | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| 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 |
| requestTime |
1..1 | instant | Time hook initiated | |
| responseTime |
0..1 | instant | Time of hook response | |
| httpResponse |
1..1 | positiveInt | e.g. 200 | |
| issue |
0..* | BackboneElement | OperationOutcome info | |
 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) | |
| tokenUse |
0..1 | code | used | not-used | rejected Binding: CRD Metric Token Use (example) | |
| orderDetail |
0..* | CodeableConcept | Service or product code(s) Binding: CRD Order Detail Codes Value Set (extensible) | |
| resources |
0..* | BackboneElement | Resource types accessed | |
| 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 | |
| prefetch |
0..1 | boolean | Retrieved by prefetch? | |
| response |
0..* | BackboneElement | Returned card/system action | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
0..1 | code | Type of CRD card Binding: CRD Card Types Value Set (required) | |
| focus |
0..* | code | Resource tied to card | |
| engagement |
0..1 | code | ignore | accept | override | |
| coverageInfo |
0..* | BackboneElement | Coverage information | |
| 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 + Binding: CRD Coverage Information Prior Authorization Value Set (required) | |
| docNeeded |
0..1 | code | no-doc | clinical | admin | both + Binding: CRD Coverage Information Additional Documentation Value Set (required) | |
| infoNeeded |
0..1 | code | performer | location | timeframe Binding: CRD Information Needed Value Set (required) | |
| questionnaire |
0..* | BackboneElement | Questionnaire(s) returned | |
| 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 |
| CRDMetricData.source | required | MetricDataSourcehttp://hl7.org/fhir/us/davinci-crd/ValueSet/metricDataSourcefrom this IG | |
| CRDMetricData.hookType | extensible | CDSHookTypehttp://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookTypefrom this IG | |
| CRDMetricData.providerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| CRDMetricData.groupId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| CRDMetricData.payerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| CRDMetricData.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-typefrom the FHIR Standard | |
| CRDMetricData.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard | |
| CRDMetricData.tokenUse | example | MetricTokenUsehttp://hl7.org/fhir/us/davinci-crd/ValueSet/metricTokenUsefrom this IG | |
| CRDMetricData.orderDetail | extensible | MetricOrderDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetailfrom this IG | |
| CRDMetricData.resources.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| CRDMetricData.response.type | required | CRDCardTypehttp://hl7.org/fhir/us/davinci-crd/ValueSet/cardTypefrom this IG | |
| CRDMetricData.response.coverageInfo.covered | required | CRDCoveredInfohttp://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfofrom this IG | |
| CRDMetricData.response.coverageInfo.paNeeded | required | CRDCoveragePaDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetailfrom this IG | |
| CRDMetricData.response.coverageInfo.docNeeded | required | CRDAdditionalDochttp://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentationfrom this IG | |
| CRDMetricData.response.coverageInfo.infoNeeded | required | CRDInformationNeededhttp://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeededfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CRDMetricData |
0..* | Base | CRD 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 Binding: CRD Metric Data Source Value Set (required) | |
| hookInstance |
1..1 | string | Unique hook invocation id | |
| hookType |
1..1 | code | order-select | order-sign + Binding: CDS Hook Types Value Set (extensible) | |
| providerId |
1..1 | Identifier | User invoking hook | |
| @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 |
Σ | 0..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 | Healthcare org of user | |
| @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 |
Σ | 0..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 hook | |
| @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) |
| requestTime |
1..1 | instant | Time hook initiated | |
| responseTime |
0..1 | instant | Time of hook response | |
| httpResponse |
1..1 | positiveInt | e.g. 200 | |
| 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) | |
| tokenUse |
0..1 | code | used | not-used | rejected Binding: CRD Metric Token Use (example) | |
| orderDetail |
0..* | CodeableConcept | Service or product code(s) Binding: CRD Order Detail Codes Value Set (extensible) | |
| 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 | |
| prefetch |
0..1 | boolean | Retrieved by prefetch? | |
| response |
0..* | BackboneElement | Returned card/system action | |
| @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 |
0..1 | code | Type of CRD card Binding: CRD Card Types Value Set (required) | |
| focus |
0..* | code | Resource tied to card | |
| engagement |
0..1 | code | ignore | accept | override | |
| 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 + Binding: CRD Coverage Information Prior Authorization Value Set (required) | |
| docNeeded |
0..1 | code | no-doc | clinical | admin | both + Binding: CRD Coverage Information Additional Documentation Value Set (required) | |
| infoNeeded |
0..1 | code | performer | location | timeframe 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 |
| CRDMetricData.source | required | MetricDataSourcehttp://hl7.org/fhir/us/davinci-crd/ValueSet/metricDataSourcefrom this IG | |
| CRDMetricData.hookType | extensible | CDSHookTypehttp://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookTypefrom this IG | |
| CRDMetricData.providerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| CRDMetricData.providerId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| CRDMetricData.groupId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| CRDMetricData.groupId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| CRDMetricData.payerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| CRDMetricData.payerId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| CRDMetricData.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-typefrom the FHIR Standard | |
| CRDMetricData.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard | |
| CRDMetricData.tokenUse | example | MetricTokenUsehttp://hl7.org/fhir/us/davinci-crd/ValueSet/metricTokenUsefrom this IG | |
| CRDMetricData.orderDetail | extensible | MetricOrderDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetailfrom this IG | |
| CRDMetricData.resources.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| CRDMetricData.response.type | required | CRDCardTypehttp://hl7.org/fhir/us/davinci-crd/ValueSet/cardTypefrom this IG | |
| CRDMetricData.response.coverageInfo.covered | required | CRDCoveredInfohttp://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfofrom this IG | |
| CRDMetricData.response.coverageInfo.paNeeded | required | CRDCoveragePaDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetailfrom this IG | |
| CRDMetricData.response.coverageInfo.docNeeded | required | CRDAdditionalDochttp://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentationfrom this IG | |
| CRDMetricData.response.coverageInfo.infoNeeded | required | CRDInformationNeededhttp://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeededfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CRDMetricData |
0..* | Base | CRD 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 Binding: CRD Metric Data Source Value Set (required) | |
| hookInstance |
1..1 | string | Unique hook invocation id | |
| hookType |
1..1 | code | order-select | order-sign + Binding: CDS Hook Types Value Set (extensible) | |
| providerId |
1..1 | Identifier | User invoking hook | |
| system |
0..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 | Healthcare org of user | |
| system |
0..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 hook | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| requestTime |
1..1 | instant | Time hook initiated | |
| responseTime |
0..1 | instant | Time of hook response | |
| httpResponse |
1..1 | positiveInt | e.g. 200 | |
| 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) | |
| tokenUse |
0..1 | code | used | not-used | rejected Binding: CRD Metric Token Use (example) | |
| orderDetail |
0..* | CodeableConcept | Service or product code(s) Binding: CRD Order Detail Codes Value Set (extensible) | |
| 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 | |
| prefetch |
0..1 | boolean | Retrieved by prefetch? | |
| response |
0..* | BackboneElement | Returned card/system action | |
| type |
0..1 | code | Type of CRD card Binding: CRD Card Types Value Set (required) | |
| focus |
0..* | code | Resource tied to card | |
| engagement |
0..1 | code | ignore | accept | override | |
| 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 + Binding: CRD Coverage Information Prior Authorization Value Set (required) | |
| docNeeded |
0..1 | code | no-doc | clinical | admin | both + Binding: CRD Coverage Information Additional Documentation Value Set (required) | |
| infoNeeded |
0..1 | code | performer | location | timeframe 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 |
| CRDMetricData.source | required | MetricDataSourcehttp://hl7.org/fhir/us/davinci-crd/ValueSet/metricDataSourcefrom this IG | |
| CRDMetricData.hookType | extensible | CDSHookTypehttp://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookTypefrom this IG | |
| CRDMetricData.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-typefrom the FHIR Standard | |
| CRDMetricData.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard | |
| CRDMetricData.tokenUse | example | MetricTokenUsehttp://hl7.org/fhir/us/davinci-crd/ValueSet/metricTokenUsefrom this IG | |
| CRDMetricData.orderDetail | extensible | MetricOrderDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetailfrom this IG | |
| CRDMetricData.resources.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| CRDMetricData.response.type | required | CRDCardTypehttp://hl7.org/fhir/us/davinci-crd/ValueSet/cardTypefrom this IG | |
| CRDMetricData.response.coverageInfo.covered | required | CRDCoveredInfohttp://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfofrom this IG | |
| CRDMetricData.response.coverageInfo.paNeeded | required | CRDCoveragePaDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetailfrom this IG | |
| CRDMetricData.response.coverageInfo.docNeeded | required | CRDAdditionalDochttp://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentationfrom this IG | |
| CRDMetricData.response.coverageInfo.infoNeeded | required | CRDInformationNeededhttp://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeededfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CRDMetricData |
0..* | Base | CRD 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 Binding: CRD Metric Data Source Value Set (required) | |
| hookInstance |
1..1 | string | Unique hook invocation id | |
| hookType |
1..1 | code | order-select | order-sign + Binding: CDS Hook Types Value Set (extensible) | |
| providerId |
1..1 | Identifier | User invoking hook | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 0..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 |
| groupId |
1..1 | Identifier | Healthcare org of user | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 0..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 |
| payerId |
1..1 | Identifier | Payer receiving hook | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| 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 |
| requestTime |
1..1 | instant | Time hook initiated | |
| responseTime |
0..1 | instant | Time of hook response | |
| httpResponse |
1..1 | positiveInt | e.g. 200 | |
| issue |
0..* | BackboneElement | OperationOutcome info | |
| 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) | |
| tokenUse |
0..1 | code | used | not-used | rejected Binding: CRD Metric Token Use (example) | |
| orderDetail |
0..* | CodeableConcept | Service or product code(s) Binding: CRD Order Detail Codes Value Set (extensible) | |
| resources |
0..* | BackboneElement | Resource types accessed | |
| 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 | |
| prefetch |
0..1 | boolean | Retrieved by prefetch? | |
| response |
0..* | BackboneElement | Returned card/system action | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
0..1 | code | Type of CRD card Binding: CRD Card Types Value Set (required) | |
| focus |
0..* | code | Resource tied to card | |
| engagement |
0..1 | code | ignore | accept | override | |
| coverageInfo |
0..* | BackboneElement | Coverage information | |
| 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 + Binding: CRD Coverage Information Prior Authorization Value Set (required) | |
| docNeeded |
0..1 | code | no-doc | clinical | admin | both + Binding: CRD Coverage Information Additional Documentation Value Set (required) | |
| infoNeeded |
0..1 | code | performer | location | timeframe Binding: CRD Information Needed Value Set (required) | |
| questionnaire |
0..* | BackboneElement | Questionnaire(s) returned | |
| 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 |
| CRDMetricData.source | required | MetricDataSourcehttp://hl7.org/fhir/us/davinci-crd/ValueSet/metricDataSourcefrom this IG | |
| CRDMetricData.hookType | extensible | CDSHookTypehttp://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookTypefrom this IG | |
| CRDMetricData.providerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| CRDMetricData.groupId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| CRDMetricData.payerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| CRDMetricData.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-typefrom the FHIR Standard | |
| CRDMetricData.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard | |
| CRDMetricData.tokenUse | example | MetricTokenUsehttp://hl7.org/fhir/us/davinci-crd/ValueSet/metricTokenUsefrom this IG | |
| CRDMetricData.orderDetail | extensible | MetricOrderDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetailfrom this IG | |
| CRDMetricData.resources.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| CRDMetricData.response.type | required | CRDCardTypehttp://hl7.org/fhir/us/davinci-crd/ValueSet/cardTypefrom this IG | |
| CRDMetricData.response.coverageInfo.covered | required | CRDCoveredInfohttp://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfofrom this IG | |
| CRDMetricData.response.coverageInfo.paNeeded | required | CRDCoveragePaDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetailfrom this IG | |
| CRDMetricData.response.coverageInfo.docNeeded | required | CRDAdditionalDochttp://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentationfrom this IG | |
| CRDMetricData.response.coverageInfo.infoNeeded | required | CRDInformationNeededhttp://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeededfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CRDMetricData |
0..* | Base | CRD 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 Binding: CRD Metric Data Source Value Set (required) | |
| hookInstance |
1..1 | string | Unique hook invocation id | |
| hookType |
1..1 | code | order-select | order-sign + Binding: CDS Hook Types Value Set (extensible) | |
| providerId |
1..1 | Identifier | User invoking hook | |
| @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 |
Σ | 0..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 | Healthcare org of user | |
| @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 |
Σ | 0..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 hook | |
| @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) |
| requestTime |
1..1 | instant | Time hook initiated | |
| responseTime |
0..1 | instant | Time of hook response | |
| httpResponse |
1..1 | positiveInt | e.g. 200 | |
| 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) | |
| tokenUse |
0..1 | code | used | not-used | rejected Binding: CRD Metric Token Use (example) | |
| orderDetail |
0..* | CodeableConcept | Service or product code(s) Binding: CRD Order Detail Codes Value Set (extensible) | |
| 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 | |
| prefetch |
0..1 | boolean | Retrieved by prefetch? | |
| response |
0..* | BackboneElement | Returned card/system action | |
| @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 |
0..1 | code | Type of CRD card Binding: CRD Card Types Value Set (required) | |
| focus |
0..* | code | Resource tied to card | |
| engagement |
0..1 | code | ignore | accept | override | |
| 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 + Binding: CRD Coverage Information Prior Authorization Value Set (required) | |
| docNeeded |
0..1 | code | no-doc | clinical | admin | both + Binding: CRD Coverage Information Additional Documentation Value Set (required) | |
| infoNeeded |
0..1 | code | performer | location | timeframe 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 |
| CRDMetricData.source | required | MetricDataSourcehttp://hl7.org/fhir/us/davinci-crd/ValueSet/metricDataSourcefrom this IG | |
| CRDMetricData.hookType | extensible | CDSHookTypehttp://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookTypefrom this IG | |
| CRDMetricData.providerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| CRDMetricData.providerId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| CRDMetricData.groupId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| CRDMetricData.groupId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| CRDMetricData.payerId.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| CRDMetricData.payerId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| CRDMetricData.issue.code | required | IssueTypehttp://hl7.org/fhir/ValueSet/issue-typefrom the FHIR Standard | |
| CRDMetricData.issue.details | example | OperationOutcomeCodeshttp://hl7.org/fhir/ValueSet/operation-outcomefrom the FHIR Standard | |
| CRDMetricData.tokenUse | example | MetricTokenUsehttp://hl7.org/fhir/us/davinci-crd/ValueSet/metricTokenUsefrom this IG | |
| CRDMetricData.orderDetail | extensible | MetricOrderDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetailfrom this IG | |
| CRDMetricData.resources.type | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| CRDMetricData.response.type | required | CRDCardTypehttp://hl7.org/fhir/us/davinci-crd/ValueSet/cardTypefrom this IG | |
| CRDMetricData.response.coverageInfo.covered | required | CRDCoveredInfohttp://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfofrom this IG | |
| CRDMetricData.response.coverageInfo.paNeeded | required | CRDCoveragePaDetailhttp://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetailfrom this IG | |
| CRDMetricData.response.coverageInfo.docNeeded | required | CRDAdditionalDochttp://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentationfrom this IG | |
| CRDMetricData.response.coverageInfo.infoNeeded | required | CRDInformationNeededhttp://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeededfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
IG © 2019+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-crd#2.1.0 based on FHIR 4.0.1. Generated 2024-11-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change