{
"description": "A logical model describing the information that should be captured by CRD implementers about every CRD invocation to support measures evaluating CRD implementation",
"_filename": "StructureDefinition-CRDMetricData.json",
"package_name": "hl7.fhir.us.davinci-crd",
"date": "2024-09-26T14:59:51-04:00",
"derivation": "specialization",
"publisher": "HL7 International / Financial Management",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "CRDMetricData",
"abstract": false,
"type": "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDMetricData",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "CRD Metric Data",
"package_version": "2.1.0-preview",
"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"
} ],
"snapshot": {
"element": [ {
"id": "CRDMetricData",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Base"
},
"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",
"isModifier": false
}, {
"path": "CRDMetricData.source",
"min": 1,
"definition": "A code to indicate which type of system collected the metric data.",
"short": "provider-src | payer-src",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/metricDataSource"
},
"max": "1",
"id": "CRDMetricData.source",
"comment": "Each hook should have metric data capture by both the initiating provider and the responding payer.",
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.source"
}
}, {
"path": "CRDMetricData.hookInstance",
"min": 1,
"definition": "The unique id for this specific hook invocation.",
"short": "Unique hook invocation id",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "CRDMetricData.hookInstance",
"comment": "Used to link the statistics for a given hook call between provider and payer systems.",
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.hookInstance"
}
}, {
"path": "CRDMetricData.hookType",
"min": 1,
"definition": "The type of hook specified in the `hook` element in the CDS hooks request.",
"short": "order-select | order-sign +",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookType"
},
"max": "1",
"id": "CRDMetricData.hookType",
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.hookType"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.providerId",
"min": 1,
"definition": "The NPI number of the user who initiated the hook request.",
"short": "User invoking hook",
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "CRDMetricData.providerId",
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.providerId"
}
}, {
"path": "CRDMetricData.providerId.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CRDMetricData.providerId.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CRDMetricData.providerId.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CRDMetricData.providerId.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.providerId.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary | old (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known ."
},
"max": "1",
"id": "CRDMetricData.providerId.use",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.providerId.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"isModifier": false,
"short": "Description of identifier",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."
},
"max": "1",
"id": "CRDMetricData.providerId.type",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.providerId.system",
"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,
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"isModifier": false,
"short": "The namespace for the identifier value",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "CRDMetricData.providerId.system",
"comment": "Identifier.system is always case sensitive.",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"patternUri": "http://hl7.org/fhir/sid/us-npi",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.providerId.value",
"min": 1,
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"isModifier": false,
"short": "The value that is unique",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "CRDMetricData.providerId.value",
"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.",
"example": [ {
"label": "General",
"valueString": "123456"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.providerId.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"isModifier": false,
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "CRDMetricData.providerId.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.providerId.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"isModifier": false,
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "CRDMetricData.providerId.assigner",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.groupId",
"min": 1,
"definition": "The NPI of the hospital/clinic/other organization that initiated the hook request.",
"short": "Healthcare org of user",
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "CRDMetricData.groupId",
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.groupId"
}
}, {
"path": "CRDMetricData.groupId.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CRDMetricData.groupId.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CRDMetricData.groupId.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CRDMetricData.groupId.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.groupId.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary | old (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known ."
},
"max": "1",
"id": "CRDMetricData.groupId.use",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.groupId.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"isModifier": false,
"short": "Description of identifier",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."
},
"max": "1",
"id": "CRDMetricData.groupId.type",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.groupId.system",
"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,
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"isModifier": false,
"short": "The namespace for the identifier value",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "CRDMetricData.groupId.system",
"comment": "Identifier.system is always case sensitive.",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"patternUri": "http://hl7.org/fhir/sid/us-npi",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.groupId.value",
"min": 1,
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"isModifier": false,
"short": "The value that is unique",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "CRDMetricData.groupId.value",
"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.",
"example": [ {
"label": "General",
"valueString": "123456"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.groupId.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"isModifier": false,
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "CRDMetricData.groupId.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.groupId.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"isModifier": false,
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "CRDMetricData.groupId.assigner",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.payerId",
"min": 1,
"definition": "The identifier of the payer organization to whom the CRD call was made.",
"short": "Payer receiving hook",
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "CRDMetricData.payerId",
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.payerId"
}
}, {
"path": "CRDMetricData.payerId.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CRDMetricData.payerId.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CRDMetricData.payerId.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CRDMetricData.payerId.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.payerId.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary | old (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known ."
},
"max": "1",
"id": "CRDMetricData.payerId.use",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.payerId.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"isModifier": false,
"short": "Description of identifier",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."
},
"max": "1",
"id": "CRDMetricData.payerId.type",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.payerId.system",
"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,
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"isModifier": false,
"short": "The namespace for the identifier value",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "CRDMetricData.payerId.system",
"comment": "Identifier.system is always case sensitive.",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.payerId.value",
"min": 1,
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"isModifier": false,
"short": "The value that is unique",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "CRDMetricData.payerId.value",
"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.",
"example": [ {
"label": "General",
"valueString": "123456"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.payerId.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"isModifier": false,
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "CRDMetricData.payerId.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.payerId.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"isModifier": false,
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "CRDMetricData.payerId.assigner",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"id": "CRDMetricData.requestTime",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.requestTime"
},
"path": "CRDMetricData.requestTime",
"type": [ {
"code": "instant"
} ],
"short": "Time hook initiated",
"definition": "For providers, the time the hook call was made. For payers, the time the hook call was received."
}, {
"id": "CRDMetricData.responseTime",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CRDMetricData.responseTime"
},
"path": "CRDMetricData.responseTime",
"type": [ {
"code": "instant"
} ],
"short": "Time of hook response",
"definition": "For providers, the time the hook response was received. For payers, the time the hook response was returned."
}, {
"id": "CRDMetricData.httpResponse",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.httpResponse"
},
"path": "CRDMetricData.httpResponse",
"type": [ {
"code": "positiveInt"
} ],
"short": "e.g. 200",
"definition": "What HTTP response code was returned for the hook invocation."
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.issue",
"min": 0,
"definition": "In the event of an HTTP error, if an OperationOutcome is returned, what were the issues?",
"short": "OperationOutcome info",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "CRDMetricData.issue",
"base": {
"max": "*",
"min": 0,
"path": "CRDMetricData.issue"
}
}, {
"path": "CRDMetricData.issue.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CRDMetricData.issue.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CRDMetricData.issue.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CRDMetricData.issue.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CRDMetricData.issue.modifierExtension",
"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).",
"min": 0,
"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).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "CRDMetricData.issue.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "CRDMetricData.issue.code",
"min": 1,
"definition": "The issue.code value from the OperationOutcome for this issue.",
"short": "Error code",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/issue-type"
},
"max": "1",
"id": "CRDMetricData.issue.code",
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.issue.code"
}
}, {
"path": "CRDMetricData.issue.details",
"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,
"definition": "The issue.details value from the OperationOutcome for this issue.",
"short": "More detailed error code",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/operation-outcome"
},
"max": "1",
"id": "CRDMetricData.issue.details",
"base": {
"max": "1",
"min": 0,
"path": "CRDMetricData.issue.details"
}
}, {
"path": "CRDMetricData.tokenUse",
"min": 0,
"definition": "Indicates whether the provided access token was used to retrieve additional information. Rejected indicates that when used, the access failed.",
"short": "used | not-used | rejected",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/metricTokenUse"
},
"max": "1",
"id": "CRDMetricData.tokenUse",
"base": {
"max": "1",
"min": 0,
"path": "CRDMetricData.tokenUse"
}
}, {
"path": "CRDMetricData.orderDetail",
"min": 0,
"definition": "The code or codes defining the type of product or service from the focal Request or",
"short": "Service or product code(s)",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetail"
},
"max": "*",
"id": "CRDMetricData.orderDetail",
"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",
"base": {
"max": "*",
"min": 0,
"path": "CRDMetricData.orderDetail"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.resources",
"min": 0,
"definition": "Information other than the 'focal' resources (orders, encounter, appointment) for the hook that were accessed by the payer.",
"short": "Resource types accessed",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "CRDMetricData.resources",
"base": {
"max": "*",
"min": 0,
"path": "CRDMetricData.resources"
}
}, {
"path": "CRDMetricData.resources.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CRDMetricData.resources.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CRDMetricData.resources.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CRDMetricData.resources.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CRDMetricData.resources.modifierExtension",
"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).",
"min": 0,
"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).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "CRDMetricData.resources.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "CRDMetricData.resources.type",
"min": 1,
"definition": "What kind of resource was accessed.",
"short": "Kind of resource",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types"
},
"max": "1",
"id": "CRDMetricData.resources.type",
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.resources.type"
}
}, {
"id": "CRDMetricData.resources.profile",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CRDMetricData.resources.profile"
},
"path": "CRDMetricData.resources.profile",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ]
} ],
"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."
}, {
"id": "CRDMetricData.resources.count",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.resources.count"
},
"path": "CRDMetricData.resources.count",
"type": [ {
"code": "positiveInt"
} ],
"short": "Number retrieved",
"definition": "How many resources of that type were accessed."
}, {
"id": "CRDMetricData.resources.prefetch",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CRDMetricData.resources.prefetch"
},
"path": "CRDMetricData.resources.prefetch",
"type": [ {
"code": "boolean"
} ],
"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.)"
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.response",
"min": 0,
"definition": "Summary information about each card or system action returned.",
"short": "Returned card/system action",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "CRDMetricData.response",
"base": {
"max": "*",
"min": 0,
"path": "CRDMetricData.response"
}
}, {
"path": "CRDMetricData.response.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CRDMetricData.response.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CRDMetricData.response.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CRDMetricData.response.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CRDMetricData.response.modifierExtension",
"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).",
"min": 0,
"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).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "CRDMetricData.response.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "CRDMetricData.response.type",
"min": 0,
"definition": "The CRD code for the card. Mandatory if the card corresponds to a type defined by CRD, otherwise omit.",
"short": "Type of CRD card",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType"
},
"max": "1",
"id": "CRDMetricData.response.type",
"base": {
"max": "1",
"min": 0,
"path": "CRDMetricData.response.type"
}
}, {
"id": "CRDMetricData.response.focus",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CRDMetricData.response.focus"
},
"path": "CRDMetricData.response.focus",
"type": [ {
"code": "code"
} ],
"short": "Resource tied to card",
"definition": "Indicates the type of resource(s) tied to the card."
}, {
"id": "CRDMetricData.response.engagement",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CRDMetricData.response.engagement"
},
"path": "CRDMetricData.response.engagement",
"type": [ {
"code": "code"
} ],
"short": "ignore | accept | override",
"definition": "Indicates if the user engaged with the card as per the CDS Hooks feedback mechanism."
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.response.coverageInfo",
"min": 0,
"definition": "If the card is a coverage-information card, indicates additional information about the information provided in the coverage-information extension.",
"short": "Coverage information",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "CRDMetricData.response.coverageInfo",
"base": {
"max": "*",
"min": 0,
"path": "CRDMetricData.response.coverageInfo"
}
}, {
"path": "CRDMetricData.response.coverageInfo.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CRDMetricData.response.coverageInfo.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CRDMetricData.response.coverageInfo.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CRDMetricData.response.coverageInfo.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CRDMetricData.response.coverageInfo.modifierExtension",
"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).",
"min": 0,
"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).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "CRDMetricData.response.coverageInfo.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "CRDMetricData.response.coverageInfo.covered",
"min": 0,
"definition": "Indicates whether the service is covered.",
"short": "covered | not-covered | conditional",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfo"
},
"max": "1",
"id": "CRDMetricData.response.coverageInfo.covered",
"base": {
"max": "1",
"min": 0,
"path": "CRDMetricData.response.coverageInfo.covered"
}
}, {
"path": "CRDMetricData.response.coverageInfo.paNeeded",
"min": 0,
"definition": "Indicates whether prior authorization is necessary or not, as well as considerations about applying for prior authorization.",
"short": "auth-needed | no-auth | satisfied +",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetail"
},
"max": "1",
"id": "CRDMetricData.response.coverageInfo.paNeeded",
"base": {
"max": "1",
"min": 0,
"path": "CRDMetricData.response.coverageInfo.paNeeded"
}
}, {
"path": "CRDMetricData.response.coverageInfo.docNeeded",
"min": 0,
"definition": "Indicates whether additional information is necessary (for prior auth, claims submission, or some other purpose).",
"short": "no-doc | clinical | admin | both +",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentation"
},
"max": "1",
"id": "CRDMetricData.response.coverageInfo.docNeeded",
"base": {
"max": "1",
"min": 0,
"path": "CRDMetricData.response.coverageInfo.docNeeded"
}
}, {
"path": "CRDMetricData.response.coverageInfo.infoNeeded",
"min": 0,
"definition": "Indicates what additional inforamtion is necessary in order to determine authorization/coverage - which might be available on a later hook invocation.",
"short": "performer | location | timeframe",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeeded"
},
"max": "1",
"id": "CRDMetricData.response.coverageInfo.infoNeeded",
"base": {
"max": "1",
"min": 0,
"path": "CRDMetricData.response.coverageInfo.infoNeeded"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CRDMetricData.response.coverageInfo.questionnaire",
"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,
"definition": "Information about the Questionnaire(s) returned to gather additional information (e.g. through DTR).",
"short": "Questionnaire(s) returned",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "CRDMetricData.response.coverageInfo.questionnaire",
"base": {
"max": "*",
"min": 0,
"path": "CRDMetricData.response.coverageInfo.questionnaire"
}
}, {
"path": "CRDMetricData.response.coverageInfo.questionnaire.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CRDMetricData.response.coverageInfo.questionnaire.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CRDMetricData.response.coverageInfo.questionnaire.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CRDMetricData.response.coverageInfo.questionnaire.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CRDMetricData.response.coverageInfo.questionnaire.modifierExtension",
"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).",
"min": 0,
"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).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "CRDMetricData.response.coverageInfo.questionnaire.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"id": "CRDMetricData.response.coverageInfo.questionnaire.reference",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.response.coverageInfo.questionnaire.reference"
},
"path": "CRDMetricData.response.coverageInfo.questionnaire.reference",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Questionnaire" ]
} ],
"short": "Questionnaire url & version",
"definition": "The official identifier of one of the Questionnaires provided to be filled out."
}, {
"id": "CRDMetricData.response.coverageInfo.questionnaire.adaptive",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.response.coverageInfo.questionnaire.adaptive"
},
"path": "CRDMetricData.response.coverageInfo.questionnaire.adaptive",
"type": [ {
"code": "boolean"
} ],
"short": "Is questionnaire adaptive?",
"definition": "If true, indicates that the questionnaire is adaptive (i.e. uses the $next-question operation to determine questions)."
}, {
"id": "CRDMetricData.response.coverageInfo.questionnaire.response",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.response.coverageInfo.questionnaire.response"
},
"path": "CRDMetricData.response.coverageInfo.questionnaire.response",
"type": [ {
"code": "boolean"
} ],
"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."
}, {
"path": "CRDMetricData.response.coverageInfo.assertionId",
"requirements": "Used to link the results of CRD to metric information captured for DTR and/or PAS.",
"min": 1,
"definition": "Corresponds to the coverage-assertion-id from the coverage-information extension.",
"short": "Id for coverage assertion",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "CRDMetricData.response.coverageInfo.assertionId",
"base": {
"max": "1",
"min": 1,
"path": "CRDMetricData.response.coverageInfo.assertionId"
}
}, {
"id": "CRDMetricData.response.coverageInfo.satisfiedId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CRDMetricData.response.coverageInfo.satisfiedId"
},
"path": "CRDMetricData.response.coverageInfo.satisfiedId",
"type": [ {
"code": "string"
} ],
"short": "Id if PA is satisfied",
"definition": "Corresponds to the satisfied-pa-id from the coverage-information extension."
}, {
"id": "CRDMetricData.response.coverageInfo.businessLine",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CRDMetricData.response.coverageInfo.businessLine"
},
"path": "CRDMetricData.response.coverageInfo.businessLine",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "E.g. MedicareAdvantage",
"definition": "A code that indicates which type of insurance this assertion applies to."
} ]
},
"status": "active",
"id": "0d33cfaf-5c59-4e05-bf3d-86e957b53281",
"kind": "logical",
"url": "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDMetricData",
"version": "2.1.0-preview",
"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"
}, {
"path": "CRDMetricData.source",
"min": 1,
"definition": "A code to indicate which type of system collected the metric data.",
"short": "provider-src | payer-src",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/metricDataSource"
},
"max": "1",
"id": "CRDMetricData.source",
"comment": "Each hook should have metric data capture by both the initiating provider and the responding payer."
}, {
"id": "CRDMetricData.hookInstance",
"max": "1",
"min": 1,
"path": "CRDMetricData.hookInstance",
"type": [ {
"code": "string"
} ],
"short": "Unique hook invocation id",
"comment": "Used to link the statistics for a given hook call between provider and payer systems.",
"definition": "The unique id for this specific hook invocation."
}, {
"id": "CRDMetricData.hookType",
"max": "1",
"min": 1,
"path": "CRDMetricData.hookType",
"type": [ {
"code": "code"
} ],
"short": "order-select | order-sign +",
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookType"
},
"definition": "The type of hook specified in the `hook` element in the CDS hooks request."
}, {
"id": "CRDMetricData.providerId",
"max": "1",
"min": 1,
"path": "CRDMetricData.providerId",
"type": [ {
"code": "Identifier"
} ],
"short": "User invoking hook",
"definition": "The NPI number of the user who initiated the hook request."
}, {
"id": "CRDMetricData.providerId.system",
"path": "CRDMetricData.providerId.system",
"patternUri": "http://hl7.org/fhir/sid/us-npi"
}, {
"id": "CRDMetricData.providerId.value",
"min": 1,
"path": "CRDMetricData.providerId.value"
}, {
"id": "CRDMetricData.groupId",
"max": "1",
"min": 1,
"path": "CRDMetricData.groupId",
"type": [ {
"code": "Identifier"
} ],
"short": "Healthcare org of user",
"definition": "The NPI of the hospital/clinic/other organization that initiated the hook request."
}, {
"id": "CRDMetricData.groupId.system",
"path": "CRDMetricData.groupId.system",
"patternUri": "http://hl7.org/fhir/sid/us-npi"
}, {
"id": "CRDMetricData.groupId.value",
"min": 1,
"path": "CRDMetricData.groupId.value"
}, {
"id": "CRDMetricData.payerId",
"max": "1",
"min": 1,
"path": "CRDMetricData.payerId",
"type": [ {
"code": "Identifier"
} ],
"short": "Payer receiving hook",
"definition": "The identifier of the payer organization to whom the CRD call was made."
}, {
"id": "CRDMetricData.payerId.system",
"min": 1,
"path": "CRDMetricData.payerId.system"
}, {
"id": "CRDMetricData.payerId.value",
"min": 1,
"path": "CRDMetricData.payerId.value"
}, {
"id": "CRDMetricData.requestTime",
"max": "1",
"min": 1,
"path": "CRDMetricData.requestTime",
"type": [ {
"code": "instant"
} ],
"short": "Time hook initiated",
"definition": "For providers, the time the hook call was made. For payers, the time the hook call was received."
}, {
"id": "CRDMetricData.responseTime",
"max": "1",
"min": 0,
"path": "CRDMetricData.responseTime",
"type": [ {
"code": "instant"
} ],
"short": "Time of hook response",
"definition": "For providers, the time the hook response was received. For payers, the time the hook response was returned."
}, {
"id": "CRDMetricData.httpResponse",
"max": "1",
"min": 1,
"path": "CRDMetricData.httpResponse",
"type": [ {
"code": "positiveInt"
} ],
"short": "e.g. 200",
"definition": "What HTTP response code was returned for the hook invocation."
}, {
"id": "CRDMetricData.issue",
"max": "*",
"min": 0,
"path": "CRDMetricData.issue",
"type": [ {
"code": "BackboneElement"
} ],
"short": "OperationOutcome info",
"definition": "In the event of an HTTP error, if an OperationOutcome is returned, what were the issues?"
}, {
"id": "CRDMetricData.issue.code",
"max": "1",
"min": 1,
"path": "CRDMetricData.issue.code",
"type": [ {
"code": "code"
} ],
"short": "Error code",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/issue-type"
},
"definition": "The issue.code value from the OperationOutcome for this issue."
}, {
"path": "CRDMetricData.issue.details",
"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,
"definition": "The issue.details value from the OperationOutcome for this issue.",
"short": "More detailed error code",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/operation-outcome"
},
"max": "1",
"id": "CRDMetricData.issue.details"
}, {
"id": "CRDMetricData.tokenUse",
"max": "1",
"min": 0,
"path": "CRDMetricData.tokenUse",
"type": [ {
"code": "code"
} ],
"short": "used | not-used | rejected",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/metricTokenUse"
},
"definition": "Indicates whether the provided access token was used to retrieve additional information. Rejected indicates that when used, the access failed."
}, {
"path": "CRDMetricData.orderDetail",
"min": 0,
"definition": "The code or codes defining the type of product or service from the focal Request or ",
"short": "Service or product code(s)",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/orderDetail"
},
"max": "*",
"id": "CRDMetricData.orderDetail",
"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"
}, {
"id": "CRDMetricData.resources",
"max": "*",
"min": 0,
"path": "CRDMetricData.resources",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Resource types accessed",
"definition": "Information other than the 'focal' resources (orders, encounter, appointment) for the hook that were accessed by the payer."
}, {
"id": "CRDMetricData.resources.type",
"max": "1",
"min": 1,
"path": "CRDMetricData.resources.type",
"type": [ {
"code": "code"
} ],
"short": "Kind of resource",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types"
},
"definition": "What kind of resource was accessed."
}, {
"id": "CRDMetricData.resources.profile",
"max": "1",
"min": 0,
"path": "CRDMetricData.resources.profile",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ]
} ],
"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."
}, {
"id": "CRDMetricData.resources.count",
"max": "1",
"min": 1,
"path": "CRDMetricData.resources.count",
"type": [ {
"code": "positiveInt"
} ],
"short": "Number retrieved",
"definition": "How many resources of that type were accessed."
}, {
"id": "CRDMetricData.resources.prefetch",
"max": "1",
"min": 0,
"path": "CRDMetricData.resources.prefetch",
"type": [ {
"code": "boolean"
} ],
"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.)"
}, {
"id": "CRDMetricData.response",
"max": "*",
"min": 0,
"path": "CRDMetricData.response",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Returned card/system action",
"definition": "Summary information about each card or system action returned."
}, {
"id": "CRDMetricData.response.type",
"max": "1",
"min": 0,
"path": "CRDMetricData.response.type",
"type": [ {
"code": "code"
} ],
"short": "Type of CRD card",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType"
},
"definition": "The CRD code for the card. Mandatory if the card corresponds to a type defined by CRD, otherwise omit."
}, {
"id": "CRDMetricData.response.focus",
"max": "*",
"min": 0,
"path": "CRDMetricData.response.focus",
"type": [ {
"code": "code"
} ],
"short": "Resource tied to card",
"definition": "Indicates the type of resource(s) tied to the card."
}, {
"id": "CRDMetricData.response.engagement",
"max": "1",
"min": 0,
"path": "CRDMetricData.response.engagement",
"type": [ {
"code": "code"
} ],
"short": "ignore | accept | override",
"definition": "Indicates if the user engaged with the card as per the CDS Hooks feedback mechanism."
}, {
"id": "CRDMetricData.response.coverageInfo",
"max": "*",
"min": 0,
"path": "CRDMetricData.response.coverageInfo",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Coverage information",
"definition": "If the card is a coverage-information card, indicates additional information about the information provided in the coverage-information extension."
}, {
"id": "CRDMetricData.response.coverageInfo.covered",
"max": "1",
"min": 0,
"path": "CRDMetricData.response.coverageInfo.covered",
"type": [ {
"code": "code"
} ],
"short": "covered | not-covered | conditional",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/coverageInfo"
},
"definition": "Indicates whether the service is covered."
}, {
"id": "CRDMetricData.response.coverageInfo.paNeeded",
"max": "1",
"min": 0,
"path": "CRDMetricData.response.coverageInfo.paNeeded",
"type": [ {
"code": "code"
} ],
"short": "auth-needed | no-auth | satisfied +",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/coveragePaDetail"
},
"definition": "Indicates whether prior authorization is necessary or not, as well as considerations about applying for prior authorization."
}, {
"id": "CRDMetricData.response.coverageInfo.docNeeded",
"max": "1",
"min": 0,
"path": "CRDMetricData.response.coverageInfo.docNeeded",
"type": [ {
"code": "code"
} ],
"short": "no-doc | clinical | admin | both +",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/AdditionalDocumentation"
},
"definition": "Indicates whether additional information is necessary (for prior auth, claims submission, or some other purpose)."
}, {
"id": "CRDMetricData.response.coverageInfo.infoNeeded",
"max": "1",
"min": 0,
"path": "CRDMetricData.response.coverageInfo.infoNeeded",
"type": [ {
"code": "code"
} ],
"short": "performer | location | timeframe",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-crd/ValueSet/informationNeeded"
},
"definition": "Indicates what additional inforamtion is necessary in order to determine authorization/coverage - which might be available on a later hook invocation."
}, {
"id": "CRDMetricData.response.coverageInfo.questionnaire",
"max": "*",
"min": 0,
"path": "CRDMetricData.response.coverageInfo.questionnaire",
"type": [ {
"code": "BackboneElement"
} ],
"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"
}, {
"id": "CRDMetricData.response.coverageInfo.questionnaire.reference",
"max": "1",
"min": 1,
"path": "CRDMetricData.response.coverageInfo.questionnaire.reference",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Questionnaire" ]
} ],
"short": "Questionnaire url & version",
"definition": "The official identifier of one of the Questionnaires provided to be filled out."
}, {
"id": "CRDMetricData.response.coverageInfo.questionnaire.adaptive",
"max": "1",
"min": 1,
"path": "CRDMetricData.response.coverageInfo.questionnaire.adaptive",
"type": [ {
"code": "boolean"
} ],
"short": "Is questionnaire adaptive?",
"definition": "If true, indicates that the questionnaire is adaptive (i.e. uses the $next-question operation to determine questions)."
}, {
"id": "CRDMetricData.response.coverageInfo.questionnaire.response",
"max": "1",
"min": 1,
"path": "CRDMetricData.response.coverageInfo.questionnaire.response",
"type": [ {
"code": "boolean"
} ],
"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."
}, {
"id": "CRDMetricData.response.coverageInfo.assertionId",
"max": "1",
"min": 1,
"path": "CRDMetricData.response.coverageInfo.assertionId",
"type": [ {
"code": "string"
} ],
"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."
}, {
"id": "CRDMetricData.response.coverageInfo.satisfiedId",
"max": "1",
"min": 0,
"path": "CRDMetricData.response.coverageInfo.satisfiedId",
"type": [ {
"code": "string"
} ],
"short": "Id if PA is satisfied",
"definition": "Corresponds to the satisfied-pa-id from the coverage-information extension."
}, {
"id": "CRDMetricData.response.coverageInfo.businessLine",
"max": "1",
"min": 0,
"path": "CRDMetricData.response.coverageInfo.businessLine",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "E.g. MedicareAdvantage",
"definition": "A code that indicates which type of insurance this assertion applies to."
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fm",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base"
}