Generated Narrative: StructureDefinition CRDMetricData Name Flags Card. Type Description & Constraints CRDMetricData 0..* Base CRD Metric Data #xD; source 1..1 code provider-src | payer-src Binding: CRD Metric Data Source Value Set (required) #xD; hookInstance 1..1 string Unique hook invocation id #xD; hookType 1..1 code order-select | order-sign + Binding: CDS Hook Types Value Set (extensible) #xD; providerId 1..1 Identifier User invoking hook #xD; system 0..1 uri The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi #xD; value 1..1 string The value that is unique #xD; groupId 1..1 Identifier Healthcare org of user #xD; system 0..1 uri The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi #xD; value 1..1 string The value that is unique #xD; payerId 1..1 Identifier Payer receiving hook #xD; system 1..1 uri The namespace for the identifier value #xD; value 1..1 string The value that is unique #xD; requestTime 1..1 instant Time hook initiated #xD; responseTime 0..1 instant Time of hook response #xD; httpResponse 1..1 positiveInt e.g. 200 #xD; issue 0..* BackboneElement OperationOutcome info #xD; code 1..1 code Error code Binding: IssueType (required) #xD; details 0..1 CodeableConcept More detailed error code Binding: OperationOutcomeCodes (example) #xD; tokenUse 1..1 code used | not-used | rejected Binding: CRD Metric Token Use Value Set (example) #xD; resources 0..* BackboneElement Resource types accessed #xD; type 1..1 code Kind of resource Binding: ResourceType (required) #xD; profile 0..1 canonical(StructureDefinition) Solicited profile #xD; count 1..1 positiveInt Number retrieved #xD; prefetch 0..1 boolean Retrieved by prefetch? #xD; request 1..* BackboneElement Request resource passed #xD; type 1..1 code Resource type Binding: Event Or Request Resource Types (required) #xD; orderDetail 1..1 CodeableConcept Service or product code(s) Binding: CRD Order Detail Codes Value Set (extensible) #xD; response 0..* BackboneElement Returned card/system action #xD; type 0..1 code Type of CRD response Binding: CRD Response Types Value Set (required) #xD; focus 0..* code Resource tied to response #xD; engagement 0..1 code ignore | accept | override #xD; coverageInfo 0..* BackboneElement Coverage information #xD; covered 0..1 code covered | not-covered | conditional Binding: CRD Coverage Information Covered Value Set (required) #xD; paNeeded 0..1 code auth-needed | no-auth | satisfied + Binding: CRD Coverage Information Prior Authorization Value Set (required) #xD; docNeeded 0..1 code no-doc | clinical | admin | both + Binding: CRD Coverage Information Additional Documentation Value Set (required) #xD; infoNeeded 0..1 code performer | location | timeframe Binding: CRD Information Needed Value Set (required) #xD; questionnaire 0..* BackboneElement Questionnaire(s) returned #xD; reference 1..1 canonical(Questionnaire) Questionnaire url & version #xD; adaptive 1..1 boolean Is questionnaire adaptive? #xD; response 1..1 boolean Pre-pop response provided? #xD; assertionId 1..1 string Id for coverage assertion #xD; satisfiedId 0..1 string Id if PA is satisfied #xD; businessLine 0..1 CodeableConcept E.g. Medicare Advantage #xD; Documentation for this format
HL7 International / Financial Management
A logical model describing the information that should be captured by CRD implementers about every CRD invocation to support measures evaluating CRD implementation
A code to indicate which type of system collected the metric data.
Each hook should have metric data captured by both the initiating provider and the responding payer.
The unique id for this specific hook invocation.
Used to link the statistics for a given hook call between provider and payer systems.
The type of hook specified in the `hook` element in the CDS hooks request.
The NPI number of the user who initiated the hook request.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
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.
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
usual | official | temp | secondary | old (If known)
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Identifies the purpose for this identifier, if known .
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
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.
Allows users to make use of identifiers when the identifier system is not known.
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Identifier.system is always case sensitive.
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.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
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.
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
Time period when id is/was valid for use
Time period during which identifier is/was valid for use.
Role.effectiveTime or implied by context
Organization that issued id (may be just text)
Organization that issued/manages the identifier.
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.
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
The NPI of the hospital/clinic/other organization that initiated the hook request.
The identifier of the payer organization to whom the CRD call was made.
For providers, the time the hook call was made. For payers, the time the hook call was received.
For providers, the time the hook response was received. For payers, the time the hook response was returned.
What HTTP response code was returned for the hook invocation.
In the event of an HTTP error, if an OperationOutcome is returned, what were the issues?
Extensions that cannot be ignored even if unrecognized
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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The issue.code value from the OperationOutcome for this issue.
The issue.details value from the OperationOutcome for this issue.
Because these codes are not standardized, they will primarily only be useful for evaluation between communication partners, not for comparison across implementations
Indicates whether the provided access token was used to retrieve additional information. Rejected indicates that when used, the access failed.
Information other than the 'focal' resources (orders, encounter, appointment) for the hook that were accessed by the payer.
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.
How many resources of that type were accessed.
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.)
Details about what request resources were passed in (and what resposnes came back)
The request resource that was passed as part of the request for an order-select, order-sign, or order-dispatch hook.
The code defining the type of product or service from the focal Request, the Encounter code, etc.
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
Summary information about each card or systemAction returned related to a given request resource. (If a card pertains to multiple orders, list the response for each).
The CRD code for the card/systemAction. Mandatory if the response corresponds to a type defined by CRD, otherwise omit.
Indicates the type of resource(s) tied to the card or systemAction.
Indicates if the user engaged with the card as per the CDS Hooks feedback mechanism. (Not relevant for systemActions.)
If the response includes a coverage-information systemAction, indicates additional information about the information provided in the coverage-information extension.
Indicates whether the service is covered.
Indicates whether prior authorization is necessary or not, as well as considerations about applying for prior authorization.
Indicates whether additional information is necessary (for prior auth, claims submission, or some other purpose).
Indicates what additional information is necessary to determine authorization/coverage - which might be available on a later hook invocation.
Information about the Questionnaire(s) returned to gather additional information (e.g. through DTR).
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
The official identifier of one of the Questionnaires provided to be filled out.
If true, it indicates that the questionnaire is adaptive (i.e. uses the $next-question operation to determine questions).
If true, it indicates that the response included a partially populated QuestionnaireResponse with answers filled by the payer from pre-known data.
Corresponds to the coverage-assertion-id from the coverage-information extension.
Used to link the results of CRD to metric information captured for DTR and/or PAS.
Corresponds to the satisfied-pa-id from the coverage-information extension.
A code that indicates which type of insurance this assertion applies to.