| Package | hl7.fhir.us.davinci-crd |
| Type | StructureDefinition |
| Id | CRDMetricData |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/davinci-crd/https://build.fhir.org/ig/HL7/davinci-crd/StructureDefinition-CRDMetricData.html |
| URL | http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDMetricData |
| Version | 2.2.0-cibuild |
| Status | active |
| Date | 2025-07-20T15:31:59+00:00 |
| Name | CRDMetricData |
| Title | CRD Metric Data |
| Realm | us |
| Authority | hl7 |
| Description | A logical model describing the information that should be captured by CRD implementers about every CRD invocation to support measures evaluating CRD implementation |
| Type | http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDMetricData |
| Kind | logical |
No resources found
| ValueSet | |
| AdditionalDocumentation | CRD Coverage Information Additional Documentation Value Set |
| cardType | CRD Card Types Value Set |
| cdsHookType | CDS Hook Types Value Set |
| coverageInfo | CRD Coverage Information Covered Value Set |
| coveragePaDetail | CRD Coverage Information Prior Authorization Value Set |
| informationNeeded | CRD Information Needed Value Set |
| metricDataSource | CRD Metric Data Source Value Set |
| metricTokenUse | CRD Metric Token Use |
| orderDetail | CRD Order Detail Codes Value Set |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition CRDMetricData
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CRDMetricData | 0..* | Base | CRD Metric Data | |
  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 | 1..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 | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "CRDMetricData",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fm"
}
],
"url": "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDMetricData",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.4.642.40.18.42.1"
}
],
"version": "2.2.0-cibuild",
"name": "CRDMetricData",
"title": "CRD Metric Data",
"status": "active",
"experimental": false,
"date": "2025-07-20T15:31:59+00:00",
"publisher": "HL7 International / Financial Management",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm"
}
]
}
],
"description": "A logical model describing the information that should be captured by CRD implementers about every CRD invocation to support measures evaluating CRD implementation",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDMetricData",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "CRDMetricData",
"path": "CRDMetricData",
"short": "CRD Metric Data",
"definition": "A logical model describing the information that should be captured by CRD implementers about every CRD invocation to support measures evaluating CRD implementation",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "CRDMetricData.source",
"path": "CRDMetricData.source",
"short": "provider-src | payer-src",
"definition": "A code to indicate which type of system collected the metric data.",
"comment": "Each hook should have metric data capture by both the initiating provider and the responding payer.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.source",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/metricDataSource"
}
},
{
"id": "CRDMetricData.hookInstance",
"path": "CRDMetricData.hookInstance",
"short": "Unique hook invocation id",
"definition": "The unique id for this specific hook invocation.",
"comment": "Used to link the statistics for a given hook call between provider and payer systems.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.hookInstance",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "CRDMetricData.hookType",
"path": "CRDMetricData.hookType",
"short": "order-select | order-sign +",
"definition": "The type of hook specified in the `hook` element in the CDS hooks request.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.hookType",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookType"
}
},
{
"id": "CRDMetricData.providerId",
"path": "CRDMetricData.providerId",
"short": "User invoking hook",
"definition": "The NPI number of the user who initiated the hook request.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.providerId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "CRDMetricData.providerId.id",
"path": "CRDMetricData.providerId.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.providerId.extension",
"path": "CRDMetricData.providerId.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.providerId.use",
"path": "CRDMetricData.providerId.use",
"short": "usual | official | temp | secondary | old (If known)",
"definition": "The purpose of this identifier.",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
}
],
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "CRDMetricData.providerId.type",
"path": "CRDMetricData.providerId.type",
"short": "Description of identifier",
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type"
},
"mapping": [
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "CRDMetricData.providerId.system",
"path": "CRDMetricData.providerId.system",
"short": "The namespace for the identifier value",
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment": "Identifier.system is always case sensitive.",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"patternUri": "http://hl7.org/fhir/sid/us-npi",
"example": [
{
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"id": "CRDMetricData.providerId.value",
"path": "CRDMetricData.providerId.value",
"short": "The value that is unique",
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "123456"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.1 / EI.1"
},
{
"identity": "rim",
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"id": "CRDMetricData.providerId.period",
"path": "CRDMetricData.providerId.period",
"short": "Time period when id is/was valid for use",
"definition": "Time period during which identifier is/was valid for use.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"id": "CRDMetricData.providerId.assigner",
"path": "CRDMetricData.providerId.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity": "rim",
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity": "servd",
"map": "./IdentifierIssuingAuthority"
}
]
},
{
"id": "CRDMetricData.groupId",
"path": "CRDMetricData.groupId",
"short": "Healthcare org of user",
"definition": "The NPI of the hospital/clinic/other organization that initiated the hook request.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.groupId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "CRDMetricData.groupId.id",
"path": "CRDMetricData.groupId.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.groupId.extension",
"path": "CRDMetricData.groupId.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.groupId.use",
"path": "CRDMetricData.groupId.use",
"short": "usual | official | temp | secondary | old (If known)",
"definition": "The purpose of this identifier.",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
}
],
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "CRDMetricData.groupId.type",
"path": "CRDMetricData.groupId.type",
"short": "Description of identifier",
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type"
},
"mapping": [
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "CRDMetricData.groupId.system",
"path": "CRDMetricData.groupId.system",
"short": "The namespace for the identifier value",
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment": "Identifier.system is always case sensitive.",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"patternUri": "http://hl7.org/fhir/sid/us-npi",
"example": [
{
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"id": "CRDMetricData.groupId.value",
"path": "CRDMetricData.groupId.value",
"short": "The value that is unique",
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "123456"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.1 / EI.1"
},
{
"identity": "rim",
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"id": "CRDMetricData.groupId.period",
"path": "CRDMetricData.groupId.period",
"short": "Time period when id is/was valid for use",
"definition": "Time period during which identifier is/was valid for use.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"id": "CRDMetricData.groupId.assigner",
"path": "CRDMetricData.groupId.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity": "rim",
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity": "servd",
"map": "./IdentifierIssuingAuthority"
}
]
},
{
"id": "CRDMetricData.payerId",
"path": "CRDMetricData.payerId",
"short": "Payer receiving hook",
"definition": "The identifier of the payer organization to whom the CRD call was made.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.payerId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "CRDMetricData.payerId.id",
"path": "CRDMetricData.payerId.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.payerId.extension",
"path": "CRDMetricData.payerId.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.payerId.use",
"path": "CRDMetricData.payerId.use",
"short": "usual | official | temp | secondary | old (If known)",
"definition": "The purpose of this identifier.",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
}
],
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "CRDMetricData.payerId.type",
"path": "CRDMetricData.payerId.type",
"short": "Description of identifier",
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type"
},
"mapping": [
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "CRDMetricData.payerId.system",
"path": "CRDMetricData.payerId.system",
"short": "The namespace for the identifier value",
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment": "Identifier.system is always case sensitive.",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"example": [
{
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"id": "CRDMetricData.payerId.value",
"path": "CRDMetricData.payerId.value",
"short": "The value that is unique",
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "123456"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.1 / EI.1"
},
{
"identity": "rim",
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"id": "CRDMetricData.payerId.period",
"path": "CRDMetricData.payerId.period",
"short": "Time period when id is/was valid for use",
"definition": "Time period during which identifier is/was valid for use.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"id": "CRDMetricData.payerId.assigner",
"path": "CRDMetricData.payerId.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity": "rim",
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity": "servd",
"map": "./IdentifierIssuingAuthority"
}
]
},
{
"id": "CRDMetricData.requestTime",
"path": "CRDMetricData.requestTime",
"short": "Time hook initiated",
"definition": "For providers, the time the hook call was made. For payers, the time the hook call was received.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.requestTime",
"min": 1,
"max": "1"
},
"type": [
{
"code": "instant"
}
]
},
{
"id": "CRDMetricData.responseTime",
"path": "CRDMetricData.responseTime",
"short": "Time of hook response",
"definition": "For providers, the time the hook response was received. For payers, the time the hook response was returned.",
"min": 0,
"max": "1",
"base": {
"path": "CRDMetricData.responseTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
]
},
{
"id": "CRDMetricData.httpResponse",
"path": "CRDMetricData.httpResponse",
"short": "e.g. 200",
"definition": "What HTTP response code was returned for the hook invocation.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.httpResponse",
"min": 1,
"max": "1"
},
"type": [
{
"code": "positiveInt"
}
]
},
{
"id": "CRDMetricData.issue",
"path": "CRDMetricData.issue",
"short": "OperationOutcome info",
"definition": "In the event of an HTTP error, if an OperationOutcome is returned, what were the issues?",
"min": 0,
"max": "*",
"base": {
"path": "CRDMetricData.issue",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "CRDMetricData.issue.id",
"path": "CRDMetricData.issue.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.issue.extension",
"path": "CRDMetricData.issue.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.issue.modifierExtension",
"path": "CRDMetricData.issue.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CRDMetricData.issue.code",
"path": "CRDMetricData.issue.code",
"short": "Error code",
"definition": "The issue.code value from the OperationOutcome for this issue.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.issue.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/issue-type"
}
},
{
"id": "CRDMetricData.issue.details",
"path": "CRDMetricData.issue.details",
"short": "More detailed error code",
"definition": "The issue.details value from the OperationOutcome for this issue.",
"requirements": "Because these codes are not standardized, they will primarily only be useful for evaluation between communication partners, not for comparison across implementations",
"min": 0,
"max": "1",
"base": {
"path": "CRDMetricData.issue.details",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/operation-outcome"
}
},
{
"id": "CRDMetricData.tokenUse",
"path": "CRDMetricData.tokenUse",
"short": "used | not-used | rejected",
"definition": "Indicates whether the provided access token was used to retrieve additional information. Rejected indicates that when used, the access failed.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.tokenUse",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/metricTokenUse"
}
},
{
"id": "CRDMetricData.orderDetail",
"path": "CRDMetricData.orderDetail",
"short": "Service or product code(s)",
"definition": "The code or codes defining the type of product or service from the focal Request or",
"comment": "Specifically, this corresponds to: Appointment.serviceType, CommunicationRequest.payload.valueCodeableConcept, DeviceRequest.codeCodeableConcept, DeviceRequest.codeReference.resolve().udiCarrier.deviceIdentifier (expressed as a CodeableConcept), Encounter.serviceType, MedicationRequest.medicationCodeableConcept, MedicationRequest.medicationReference.resolve().code, ServiceRequest.code, VisionPrescription.lensSpecification.productType",
"min": 0,
"max": "*",
"base": {
"path": "CRDMetricData.orderDetail",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetail"
}
},
{
"id": "CRDMetricData.resources",
"path": "CRDMetricData.resources",
"short": "Resource types accessed",
"definition": "Information other than the 'focal' resources (orders, encounter, appointment) for the hook that were accessed by the payer.",
"min": 0,
"max": "*",
"base": {
"path": "CRDMetricData.resources",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "CRDMetricData.resources.id",
"path": "CRDMetricData.resources.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.resources.extension",
"path": "CRDMetricData.resources.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.resources.modifierExtension",
"path": "CRDMetricData.resources.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CRDMetricData.resources.type",
"path": "CRDMetricData.resources.type",
"short": "Kind of resource",
"definition": "What kind of resource was accessed.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.resources.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types"
}
},
{
"id": "CRDMetricData.resources.profile",
"path": "CRDMetricData.resources.profile",
"short": "Solicited profile",
"definition": "Indicates the sub-type of data accessed in situations where multiple US-core profiles could apply (e.g. Observation). Note: This does not mean that the data received was actually valid against the profile, merely that the search criteria used were intended to retrieve data of this type.",
"min": 0,
"max": "1",
"base": {
"path": "CRDMetricData.resources.profile",
"min": 0,
"max": "1"
},
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
]
},
{
"id": "CRDMetricData.resources.count",
"path": "CRDMetricData.resources.count",
"short": "Number retrieved",
"definition": "How many resources of that type were accessed.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.resources.count",
"min": 1,
"max": "1"
},
"type": [
{
"code": "positiveInt"
}
]
},
{
"id": "CRDMetricData.resources.prefetch",
"path": "CRDMetricData.resources.prefetch",
"short": "Retrieved by prefetch?",
"definition": "Was the data retrieved by prefetch or direct query. (If some resources of the same type were accessed both with and without prefetch, include two repetitions.)",
"min": 0,
"max": "1",
"base": {
"path": "CRDMetricData.resources.prefetch",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CRDMetricData.response",
"path": "CRDMetricData.response",
"short": "Returned card/system action",
"definition": "Summary information about each card or system action returned.",
"min": 0,
"max": "*",
"base": {
"path": "CRDMetricData.response",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "CRDMetricData.response.id",
"path": "CRDMetricData.response.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.response.extension",
"path": "CRDMetricData.response.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.response.modifierExtension",
"path": "CRDMetricData.response.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CRDMetricData.response.type",
"path": "CRDMetricData.response.type",
"short": "Type of CRD card",
"definition": "The CRD code for the card. Mandatory if the card corresponds to a type defined by CRD, otherwise omit.",
"min": 0,
"max": "1",
"base": {
"path": "CRDMetricData.response.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType"
}
},
{
"id": "CRDMetricData.response.focus",
"path": "CRDMetricData.response.focus",
"short": "Resource tied to card",
"definition": "Indicates the type of resource(s) tied to the card.",
"min": 0,
"max": "*",
"base": {
"path": "CRDMetricData.response.focus",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "CRDMetricData.response.engagement",
"path": "CRDMetricData.response.engagement",
"short": "ignore | accept | override",
"definition": "Indicates if the user engaged with the card as per the CDS Hooks feedback mechanism.",
"min": 0,
"max": "1",
"base": {
"path": "CRDMetricData.response.engagement",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo",
"path": "CRDMetricData.response.coverageInfo",
"short": "Coverage information",
"definition": "If the card is a coverage-information card, indicates additional information about the information provided in the coverage-information extension.",
"min": 0,
"max": "*",
"base": {
"path": "CRDMetricData.response.coverageInfo",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.id",
"path": "CRDMetricData.response.coverageInfo.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.extension",
"path": "CRDMetricData.response.coverageInfo.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.modifierExtension",
"path": "CRDMetricData.response.coverageInfo.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.covered",
"path": "CRDMetricData.response.coverageInfo.covered",
"short": "covered | not-covered | conditional",
"definition": "Indicates whether the service is covered.",
"min": 0,
"max": "1",
"base": {
"path": "CRDMetricData.response.coverageInfo.covered",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfo"
}
},
{
"id": "CRDMetricData.response.coverageInfo.paNeeded",
"path": "CRDMetricData.response.coverageInfo.paNeeded",
"short": "auth-needed | no-auth | satisfied +",
"definition": "Indicates whether prior authorization is necessary or not, as well as considerations about applying for prior authorization.",
"min": 0,
"max": "1",
"base": {
"path": "CRDMetricData.response.coverageInfo.paNeeded",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetail"
}
},
{
"id": "CRDMetricData.response.coverageInfo.docNeeded",
"path": "CRDMetricData.response.coverageInfo.docNeeded",
"short": "no-doc | clinical | admin | both +",
"definition": "Indicates whether additional information is necessary (for prior auth, claims submission, or some other purpose).",
"min": 0,
"max": "1",
"base": {
"path": "CRDMetricData.response.coverageInfo.docNeeded",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentation"
}
},
{
"id": "CRDMetricData.response.coverageInfo.infoNeeded",
"path": "CRDMetricData.response.coverageInfo.infoNeeded",
"short": "performer | location | timeframe",
"definition": "Indicates what additional inforamtion is necessary in order to determine authorization/coverage - which might be available on a later hook invocation.",
"min": 0,
"max": "1",
"base": {
"path": "CRDMetricData.response.coverageInfo.infoNeeded",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeeded"
}
},
{
"id": "CRDMetricData.response.coverageInfo.questionnaire",
"path": "CRDMetricData.response.coverageInfo.questionnaire",
"short": "Questionnaire(s) returned",
"definition": "Information about the Questionnaire(s) returned to gather additional information (e.g. through DTR).",
"requirements": "Allows linking metadata about forms identified 'to be filled out' in CRD with what is actually completed in DTR, and eventually submitted in CDex, PAS or claims",
"min": 0,
"max": "*",
"base": {
"path": "CRDMetricData.response.coverageInfo.questionnaire",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.questionnaire.id",
"path": "CRDMetricData.response.coverageInfo.questionnaire.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.questionnaire.extension",
"path": "CRDMetricData.response.coverageInfo.questionnaire.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.questionnaire.modifierExtension",
"path": "CRDMetricData.response.coverageInfo.questionnaire.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.questionnaire.reference",
"path": "CRDMetricData.response.coverageInfo.questionnaire.reference",
"short": "Questionnaire url & version",
"definition": "The official identifier of one of the Questionnaires provided to be filled out.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.response.coverageInfo.questionnaire.reference",
"min": 1,
"max": "1"
},
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Questionnaire"
]
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.questionnaire.adaptive",
"path": "CRDMetricData.response.coverageInfo.questionnaire.adaptive",
"short": "Is questionnaire adaptive?",
"definition": "If true, indicates that the questionnaire is adaptive (i.e. uses the $next-question operation to determine questions).",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.response.coverageInfo.questionnaire.adaptive",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.questionnaire.response",
"path": "CRDMetricData.response.coverageInfo.questionnaire.response",
"short": "Pre-pop response provided?",
"definition": "If true, indicates that the card included a partially populated QuestionnaireResponse with answers filled by the payer from pre-known data.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.response.coverageInfo.questionnaire.response",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.assertionId",
"path": "CRDMetricData.response.coverageInfo.assertionId",
"short": "Id for coverage assertion",
"definition": "Corresponds to the coverage-assertion-id from the coverage-information extension.",
"requirements": "Used to link the results of CRD to metric information captured for DTR and/or PAS.",
"min": 1,
"max": "1",
"base": {
"path": "CRDMetricData.response.coverageInfo.assertionId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.satisfiedId",
"path": "CRDMetricData.response.coverageInfo.satisfiedId",
"short": "Id if PA is satisfied",
"definition": "Corresponds to the satisfied-pa-id from the coverage-information extension.",
"min": 0,
"max": "1",
"base": {
"path": "CRDMetricData.response.coverageInfo.satisfiedId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.businessLine",
"path": "CRDMetricData.response.coverageInfo.businessLine",
"short": "E.g. MedicareAdvantage",
"definition": "A code that indicates which type of insurance this assertion applies to.",
"min": 0,
"max": "1",
"base": {
"path": "CRDMetricData.response.coverageInfo.businessLine",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
}
]
},
"differential": {
"element": [
{
"id": "CRDMetricData",
"path": "CRDMetricData",
"short": "CRD Metric Data",
"definition": "A logical model describing the information that should be captured by CRD implementers about every CRD invocation to support measures evaluating CRD implementation"
},
{
"id": "CRDMetricData.source",
"path": "CRDMetricData.source",
"short": "provider-src | payer-src",
"definition": "A code to indicate which type of system collected the metric data.",
"comment": "Each hook should have metric data capture by both the initiating provider and the responding payer.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/metricDataSource"
}
},
{
"id": "CRDMetricData.hookInstance",
"path": "CRDMetricData.hookInstance",
"short": "Unique hook invocation id",
"definition": "The unique id for this specific hook invocation.",
"comment": "Used to link the statistics for a given hook call between provider and payer systems.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CRDMetricData.hookType",
"path": "CRDMetricData.hookType",
"short": "order-select | order-sign +",
"definition": "The type of hook specified in the `hook` element in the CDS hooks request.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookType"
}
},
{
"id": "CRDMetricData.providerId",
"path": "CRDMetricData.providerId",
"short": "User invoking hook",
"definition": "The NPI number of the user who initiated the hook request.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "CRDMetricData.providerId.system",
"path": "CRDMetricData.providerId.system",
"patternUri": "http://hl7.org/fhir/sid/us-npi"
},
{
"id": "CRDMetricData.providerId.value",
"path": "CRDMetricData.providerId.value",
"min": 1
},
{
"id": "CRDMetricData.groupId",
"path": "CRDMetricData.groupId",
"short": "Healthcare org of user",
"definition": "The NPI of the hospital/clinic/other organization that initiated the hook request.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "CRDMetricData.groupId.system",
"path": "CRDMetricData.groupId.system",
"patternUri": "http://hl7.org/fhir/sid/us-npi"
},
{
"id": "CRDMetricData.groupId.value",
"path": "CRDMetricData.groupId.value",
"min": 1
},
{
"id": "CRDMetricData.payerId",
"path": "CRDMetricData.payerId",
"short": "Payer receiving hook",
"definition": "The identifier of the payer organization to whom the CRD call was made.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "CRDMetricData.payerId.system",
"path": "CRDMetricData.payerId.system",
"min": 1
},
{
"id": "CRDMetricData.payerId.value",
"path": "CRDMetricData.payerId.value",
"min": 1
},
{
"id": "CRDMetricData.requestTime",
"path": "CRDMetricData.requestTime",
"short": "Time hook initiated",
"definition": "For providers, the time the hook call was made. For payers, the time the hook call was received.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"id": "CRDMetricData.responseTime",
"path": "CRDMetricData.responseTime",
"short": "Time of hook response",
"definition": "For providers, the time the hook response was received. For payers, the time the hook response was returned.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"id": "CRDMetricData.httpResponse",
"path": "CRDMetricData.httpResponse",
"short": "e.g. 200",
"definition": "What HTTP response code was returned for the hook invocation.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
},
{
"id": "CRDMetricData.issue",
"path": "CRDMetricData.issue",
"short": "OperationOutcome info",
"definition": "In the event of an HTTP error, if an OperationOutcome is returned, what were the issues?",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "CRDMetricData.issue.code",
"path": "CRDMetricData.issue.code",
"short": "Error code",
"definition": "The issue.code value from the OperationOutcome for this issue.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/issue-type"
}
},
{
"id": "CRDMetricData.issue.details",
"path": "CRDMetricData.issue.details",
"short": "More detailed error code",
"definition": "The issue.details value from the OperationOutcome for this issue.",
"requirements": "Because these codes are not standardized, they will primarily only be useful for evaluation between communication partners, not for comparison across implementations",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/operation-outcome"
}
},
{
"id": "CRDMetricData.tokenUse",
"path": "CRDMetricData.tokenUse",
"short": "used | not-used | rejected",
"definition": "Indicates whether the provided access token was used to retrieve additional information. Rejected indicates that when used, the access failed.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/metricTokenUse"
}
},
{
"id": "CRDMetricData.orderDetail",
"path": "CRDMetricData.orderDetail",
"short": "Service or product code(s)",
"definition": "The code or codes defining the type of product or service from the focal Request or ",
"comment": "Specifically, this corresponds to: Appointment.serviceType, CommunicationRequest.payload.valueCodeableConcept, DeviceRequest.codeCodeableConcept, DeviceRequest.codeReference.resolve().udiCarrier.deviceIdentifier (expressed as a CodeableConcept), Encounter.serviceType, MedicationRequest.medicationCodeableConcept, MedicationRequest.medicationReference.resolve().code, ServiceRequest.code, VisionPrescription.lensSpecification.productType",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetail"
}
},
{
"id": "CRDMetricData.resources",
"path": "CRDMetricData.resources",
"short": "Resource types accessed",
"definition": "Information other than the 'focal' resources (orders, encounter, appointment) for the hook that were accessed by the payer.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "CRDMetricData.resources.type",
"path": "CRDMetricData.resources.type",
"short": "Kind of resource",
"definition": "What kind of resource was accessed.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types"
}
},
{
"id": "CRDMetricData.resources.profile",
"path": "CRDMetricData.resources.profile",
"short": "Solicited profile",
"definition": "Indicates the sub-type of data accessed in situations where multiple US-core profiles could apply (e.g. Observation). Note: This does not mean that the data received was actually valid against the profile, merely that the search criteria used were intended to retrieve data of this type.",
"min": 0,
"max": "1",
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition"
]
}
]
},
{
"id": "CRDMetricData.resources.count",
"path": "CRDMetricData.resources.count",
"short": "Number retrieved",
"definition": "How many resources of that type were accessed.",
"min": 1,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
},
{
"id": "CRDMetricData.resources.prefetch",
"path": "CRDMetricData.resources.prefetch",
"short": "Retrieved by prefetch?",
"definition": "Was the data retrieved by prefetch or direct query. (If some resources of the same type were accessed both with and without prefetch, include two repetitions.)",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CRDMetricData.response",
"path": "CRDMetricData.response",
"short": "Returned card/system action",
"definition": "Summary information about each card or system action returned.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "CRDMetricData.response.type",
"path": "CRDMetricData.response.type",
"short": "Type of CRD card",
"definition": "The CRD code for the card. Mandatory if the card corresponds to a type defined by CRD, otherwise omit.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType"
}
},
{
"id": "CRDMetricData.response.focus",
"path": "CRDMetricData.response.focus",
"short": "Resource tied to card",
"definition": "Indicates the type of resource(s) tied to the card.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
]
},
{
"id": "CRDMetricData.response.engagement",
"path": "CRDMetricData.response.engagement",
"short": "ignore | accept | override",
"definition": "Indicates if the user engaged with the card as per the CDS Hooks feedback mechanism.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo",
"path": "CRDMetricData.response.coverageInfo",
"short": "Coverage information",
"definition": "If the card is a coverage-information card, indicates additional information about the information provided in the coverage-information extension.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.covered",
"path": "CRDMetricData.response.coverageInfo.covered",
"short": "covered | not-covered | conditional",
"definition": "Indicates whether the service is covered.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfo"
}
},
{
"id": "CRDMetricData.response.coverageInfo.paNeeded",
"path": "CRDMetricData.response.coverageInfo.paNeeded",
"short": "auth-needed | no-auth | satisfied +",
"definition": "Indicates whether prior authorization is necessary or not, as well as considerations about applying for prior authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetail"
}
},
{
"id": "CRDMetricData.response.coverageInfo.docNeeded",
"path": "CRDMetricData.response.coverageInfo.docNeeded",
"short": "no-doc | clinical | admin | both +",
"definition": "Indicates whether additional information is necessary (for prior auth, claims submission, or some other purpose).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentation"
}
},
{
"id": "CRDMetricData.response.coverageInfo.infoNeeded",
"path": "CRDMetricData.response.coverageInfo.infoNeeded",
"short": "performer | location | timeframe",
"definition": "Indicates what additional inforamtion is necessary in order to determine authorization/coverage - which might be available on a later hook invocation.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeeded"
}
},
{
"id": "CRDMetricData.response.coverageInfo.questionnaire",
"path": "CRDMetricData.response.coverageInfo.questionnaire",
"short": "Questionnaire(s) returned",
"definition": "Information about the Questionnaire(s) returned to gather additional information (e.g. through DTR).",
"requirements": "Allows linking metadata about forms identified 'to be filled out' in CRD with what is actually completed in DTR, and eventually submitted in CDex, PAS or claims",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.questionnaire.reference",
"path": "CRDMetricData.response.coverageInfo.questionnaire.reference",
"short": "Questionnaire url & version",
"definition": "The official identifier of one of the Questionnaires provided to be filled out.",
"min": 1,
"max": "1",
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Questionnaire"
]
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.questionnaire.adaptive",
"path": "CRDMetricData.response.coverageInfo.questionnaire.adaptive",
"short": "Is questionnaire adaptive?",
"definition": "If true, indicates that the questionnaire is adaptive (i.e. uses the $next-question operation to determine questions).",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.questionnaire.response",
"path": "CRDMetricData.response.coverageInfo.questionnaire.response",
"short": "Pre-pop response provided?",
"definition": "If true, indicates that the card included a partially populated QuestionnaireResponse with answers filled by the payer from pre-known data.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.assertionId",
"path": "CRDMetricData.response.coverageInfo.assertionId",
"short": "Id for coverage assertion",
"definition": "Corresponds to the coverage-assertion-id from the coverage-information extension.",
"requirements": "Used to link the results of CRD to metric information captured for DTR and/or PAS.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.satisfiedId",
"path": "CRDMetricData.response.coverageInfo.satisfiedId",
"short": "Id if PA is satisfied",
"definition": "Corresponds to the satisfied-pa-id from the coverage-information extension.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "CRDMetricData.response.coverageInfo.businessLine",
"path": "CRDMetricData.response.coverageInfo.businessLine",
"short": "E.g. MedicareAdvantage",
"definition": "A code that indicates which type of insurance this assertion applies to.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
}
]
}
}