StructureDefinition-cdex-task-data-request

Source

hl7.fhir.us.davinci-cdex#current:Da Vinci Clinical Data Exchange (CDex) (v4.0.1)

resourceType

StructureDefinition

cdex-task-data-request

canonical

http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request

version

2.1.0-preview

status

active

publisher

HL7 International - Patient Care Work Group

name

CDexTaskDataRequest

title

CDex Task Data Request Profile

date

2023-05-26T04:44:34+00:00

description

This Task profile is used to solicit information from a system. The Data Consumer uses it when direct query transactions are not an option, and the transaction may require human intervention. It represents both the data request and the returned "data request". Data requests are supplied as codes, free-text, or FHIR Restful queries. It can also support requests for more detailed missing data using Questionnaire, CQL, and QuestionnaireResponse as supported by Da Vinci DTR. It constrains the following elements to be *mandatory* (min=1): - A Task.status with a required binding to HRex [Task Status ValueSet](http://hl7.org/fhir/us/davinci-hrex/STU1/ValueSet-hrex-task-status.html) (this element is a mandatory Task element). For guidance when the provider is not able to complete the Task, refer to the [When The Task Cannot Be Completed section](http://hl7.org/fhir/us/davinci-cdex/STU2/task-based-approach.html#when-the-task-cannot-be-completed). - A Task.intent fixed to "order" (this element is a mandatory Task element) - A Task.code of either "data-request-code", "data-request-code", or "data-request-questionnaire" communicating that the Data Consumer is requesting data using a code(or free text), a FHIR RESTful query, or a data request questionnaire. - If the code is "data-request-query", the provider system returns data(s) identified by the FHIR RESTful query in the "query" input parameter. - If the code is "data-request-code", the provider system returns data(s) identified by the LOINC code in the "code" input parameter. - If the code is "data-request-questionnaire", the provider system uses [Documentation Templates and Rules (DTR)](http://hl7.org/fhir/us/davinci-dtr/2022May/) to complete the Questionnaire referenced in the "questionnaire" input parameter. - A Task.for element representing the member (i.e.,patient) for whom the data is being requested - A Task.requester element communicating who is requesting the data - A Task.owner element representing the Provider who is being asked to provide the data It constrains following elements to be [*must support*](task-based-conformance.html#cdex-must-support-definition) (min=0): - A Task.identifier element representing the unique data request identifier - A Task.basedOn element to communicate the order (ServiceRequest, CommunicationRequest, etc.) that authorizes the data request - A Task.statusReason.text to communicate the reason for the status (for example, if the Task is rejected or failed) - A Task.businessStatus.text element representing the progress in retrieving the data (for example, "waiting on internal review"). - A Task.for.reference.identifier element representing a patient business identifier like a Member ID - A Task.requester.reference.identifier element representing the Data Consumer business identifier - A Task.owner.reference.identifier element representing the Provider business identifier - A Task.reasonCode.text to communicate why the data is being requested - A Task.reasonReference.reference.identifier for the claim, pre-auth or coverage business identifier - A "query" Task.input element to communicate to the provider what information is needed using a FHIR RESTful query.* - A "code" Task.input element to communicate to the provider what information is needed using a LOINC code.* - For the "code" Task.input element, an extensible LOINC® Document types value set to communicate the specific information being requested - A Task.input element representing a flag to indicate whether the requested data requires a signature - A "data" Task.output element referring to FHIR resource(s) representing the result(s) of the data request code. It defines the following elements to be *optional*: - A meta.tag element representing work-queue hints. - A "questionnaire" Task.input element to communicate to the provider a URL of a data request [FHIR Questionnaire](http://hl7.org/fhir/questionnaire.html) that conforms to the [DTR SDC Questionnaire Profile](http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-sdc-questionnaire) or the [DTR SDC Questionnaire for Adaptive Form Profile](http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-sdc-questionnaire-adapt).* - A questionnaireDisplay extension to communicate the display name of the Questionnaire - A Task.input element representing the purpose of use for the requested data using an extensible [CDex Purpose of Use Value Set](http://hl7.org/fhir/us/davinci-cdex/ValueSet/cdex-POU) - A "response" Task.output element which is a local reference to the [FHIR QuestionnaireResponse](http://hl7.org/fhir/questionnaireresponse.html) resulting from the data request Questionnaire. The QuestionnaireResponse conforms to the [SDC Questionnaire Response Profile](http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse) or the [SDC Adaptive Questionnaire Response Profile](http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse-adapt). It prohibits the following elements (max=0): - Task.focus \* Either a "query", "code", or "questionnaire" Task.input element is required

jurisdictions

fhirVersion

4.0.1

kind

resource

abstract

false

sdTtype

Task

derivation

constraint

base

http://hl7.org/fhir/StructureDefinition/Task

Usages

Data Consumer Client CapabilityStatement (profile)
Data Source Server CapabilityStatement (profile)

Name	Flags	Card.	Type	Description & Constraints
Task	C		Task	cdex-7: If code = "data-request-code", must have one "code" input. cdex-12: If code = "data-request-query", must have one "query" input. cdex-8: If code = "data-request-questionnaire", must have one "questionnaire" input. cdex-9: Must have exactly one input that is data-query or data-code or questionnaire tdr-2: Task statusReason SHALL be populated if status is 'rejected' or 'failed' tdr-3: Task output SHALL be populated if status is 'completed' cdex-11: If code = "data-request-questionnaire" and status = "completed", should have one "questionnaire-response" output referencing the QuestionnaireResponse.
meta
Slices for tag				Slice: Unordered, Open by pattern:$this
tag:All Slices				Content/Rules for all slices
system
code		1..
tag:work-queue				Work Queue Tag Binding: CDex Work Queue Value Set ( required )
identifier	S
basedOn	S			Authorization for data request
status	S C			Binding: HRex Task Status ValueSet ( required )
statusReason	S C
text	S	1..
businessStatus	S			For example, 'waiting on internal review'
text	S	1..
intent	S			Fixed Value: order
code	S C	1..		data-request-code \| data-request-query \| data-request-questionnaire Binding: CDex Data Request Task Code Value Set ( required )
coding	S	1..
system	S			Fixed Value: http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-temp
code	S	1..
focus		0 .. 0
for	S	1..	Reference (US Core Patient Profile)	Member (i.e., patient) being queried
identifier	S			Patient Member ID
authoredOn	S	1..
requester	S	1..	Reference (US Core Organization Profile \| US Core Practitioner Profile)	Who is asking for data
identifier	S			Data Consumer ID
owner	S	1..	Reference (US Core Organization Profile \| US Core Practitioner Profile)	Who is being asked for data
identifier	S			Provider ID
reasonCode	S
text	S	1..
reasonReference	S		Reference ( Claim \| HRex Coverage Profile)
identifier	S			Coverage or Claim ID
Slices for input	S	1 ..		Slice: Unordered, Open by pattern:type
input:query	S C	..1		Requested query
type	S			Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
code		1..1	code	Symbol in syntax defined by the system Fixed Value: data-query
value[x]	S		string	query value
input:code	S C	..1		Requested data code
type	S			Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
code		1..1	code	Symbol in syntax defined by the system Fixed Value: data-code
value[x]	S	1..1	CodeableConcept	query value Binding: US Core DocumentReference Type ( extensible )
input:questionnaire	C D	..1		Data Request questionnaire
type		1..1	CodeableConcept	Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp
code		1..1	code	Symbol in syntax defined by the system Fixed Value: questionnaire
value[x]		1..1	canonical (http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-sdc-questionnaire \| http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-sdc-questionnaire-adapt)	URL
questionnaireDisplay		0..1	string	Display name for canonical reference URL: http://hl7.org/fhir/StructureDefinition/display
input:signature	S	..1		Signature flag
type	S			Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-temp
code		1..1	code	Symbol in syntax defined by the system Fixed Value: signature-flag
value[x]	S		boolean	Signature flag value
input:POU		..1		Purpose of use code
type				Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-cdex/CodeSystem/cdex-temp
code		1..1	code	Symbol in syntax defined by the system Fixed Value: purpose-of-use
value[x]			CodeableConcept	Purpose of use value Binding: CDex Purpose of Use Value Set ( extensible )
Slices for output	S C			Slice: Unordered, Open by pattern:type
output:data	S			Requested data
type	S			Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-hrex/CodeSystem/hrex-temp
code		1..1	code	Symbol in syntax defined by the system Fixed Value: data-value
value[x]	S		Reference ()	data reference
output:response	C D	..1
type			CodeableConcept	Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/sdc/CodeSystem/temp
code		1..1	code	Symbol in syntax defined by the system Fixed Value: questionnaire-response
value[x]		1..1	Reference (SDC Questionnaire Response \| Adaptive Questionnaire Response)	Reference to the QuestionnaireResponse
Documentation for this format

Produced 08 Sep 2023