{
"description": "This IG provides detailed guidance that helps implementers use FHIR-based interactions to support specific exchanges of clinical data between providers and payers (or other providers).",
"_filename": "ig-r4.json",
"package_name": "hl7.fhir.us.davinci",
"definition": {
"page": {
"page": [ {
"title": "Home",
"nameUrl": "index.html",
"generation": "markdown"
}, {
"title": "Background",
"nameUrl": "background.html",
"generation": "markdown"
}, {
"page": [ {
"title": "Exchanging Clinical Data",
"nameUrl": "exchanging-clinical-data.html",
"generation": "markdown"
}, {
"title": "Direct Query",
"nameUrl": "direct-query.html",
"generation": "markdown"
}, {
"title": "Task Based Approach",
"nameUrl": "task-based-approach.html",
"generation": "markdown"
}, {
"title": "Attachments",
"nameUrl": "attachments.html",
"generation": "markdown"
} ],
"title": "Specification",
"nameUrl": "specification.html",
"generation": "markdown"
}, {
"page": [ {
"title": "Signed Searchset Bundle Example",
"nameUrl": "signed-searchset-bundle-example.html",
"generation": "markdown"
}, {
"title": "Signed Document Bundle Example",
"nameUrl": "signed-document-bundle-example.html",
"generation": "markdown"
} ],
"title": "Signatures",
"nameUrl": "signatures.html",
"generation": "markdown"
}, {
"title": "Security and Privacy",
"nameUrl": "security.html",
"generation": "markdown"
}, {
"title": "Downloads",
"nameUrl": "downloads.html",
"generation": "markdown"
} ],
"title": "Table of Contents",
"nameUrl": "toc.html",
"generation": "html"
},
"resource": [ {
"name": "Submit Attachment Operation",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "OperationDefinition"
} ],
"reference": {
"reference": "OperationDefinition/submit-attachment"
},
"description": "This operation is used to submit attachments (aditional information) for Claims or Prior Authorization. This operation accepts the clinical/administrative attachments and the necessary information needed to re-associate them to the claim or prior authorization, and returns a transaction layer HTTP response. This operation can be used by any HTTP endpoint, not just FHIR RESTful servers.\n\nThe input parameters are:\n1. One or more Attachments as FHIR Resources\n1. Data elements for reassociation to the Claim/Prior Authorization\n - What is the documentation for:\n - Claim\n - Prior Authorization\n - A unique claim/prior authorization identifier (referred to as the \"re-association tracking control numbers\")*\n - Optionally, one or more unique claim line item identifiers\n - A unique organization/location identifier (e.g., NPI)\n - A unique provider identifier (e.g., NPI)\n - A unique Patient member identifier\n - Date of Service\n\nThere are no output parameters.",
"exampleBoolean": false
}, {
"name": "Data Consumer Client CapabilityStatement",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CapabilityStatement"
} ],
"reference": {
"reference": "CapabilityStatement/data-consumer-client"
},
"description": "This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Consumer (often a Payer) in *Client* mode when requesting clinical data from the Data Source (often an EHR) during a clinical data exchange. This includes the following interactions:\n\n1. Requesting Clinical Data using a FHIR RESTful query\n1. POSTing a Task resource representing a request for clinical data\n1. POSTing a Subscription resource\n1. Polling a Task resource",
"exampleBoolean": false
}, {
"name": "Data Consumer Server CapabilityStatement",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CapabilityStatement"
} ],
"reference": {
"reference": "CapabilityStatement/data-consumer-server"
},
"description": "This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Consumer (often a Payer) in *Server* mode when responding to a Data Source (often an EHR) or one of its proxies during a clinical data exchange. This includes the following interactions:\n\n1. Responding to a query for authorization information represented by a CommunicationRequest or ServiceRequest\n1. Responding to subscription notification posted to it endpoint updating the status of a task\n1. Responding to `$submit-attachment` operation.",
"exampleBoolean": false
}, {
"name": "Data Source Client CapabilityStatement",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CapabilityStatement"
} ],
"reference": {
"reference": "CapabilityStatement/data-source-client"
},
"description": "This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Source (often an EHR) in *Client* mode during a clinical data exchange with a Data Consumer. This includes the following interactions:\n1. POSTing the `$submit-attachment` operation to exchange clinical data using a FHIR based Attachments transaction.\n1. Query for Authorization information represented by a CommunicationRequest or ServiceRequest.\n1. Posting a subscription notification to a Data Consumer endpoint updating the status of a Task.",
"exampleBoolean": false
}, {
"name": "Data Source Server CapabilityStatement",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CapabilityStatement"
} ],
"reference": {
"reference": "CapabilityStatement/data-source-server"
},
"description": "This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Source (often an EHR) in *Server* mode when responding to a Data Consumer (often a Payer) during a clinical data exchange. This includes the following interactions:\n\n1. Responding to a FHIR RestFul Query for Clinical Data \n1. Responding to a POST of a Task resource representing a request for clinical data\n1. Responding to a POST of a Subscription resource\n1. Responding to polling of a Task resource",
"exampleBoolean": false
}, {
"name": "CDex Temporary Code System",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "CodeSystem"
} ],
"reference": {
"reference": "CodeSystem/cdex-temp"
},
"description": "Codes temporarily defined as part of the CDex implementation guide. These will eventually migrate into an officially maintained terminology (likely HL7's [UTG](https://terminology.hl7.org/codesystems.html) code systems).",
"exampleBoolean": false
}, {
"name": "CDex Task Data Request Profile",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "StructureDefinition:resource"
} ],
"reference": {
"reference": "StructureDefinition/cdex-task-data-request"
},
"description": "This Task profile is based upon the [Da Vinci Hrex Task Data Request](http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-task-data-request). It adds the following additional constraints for CDEX:\n- A 'meta.tag' element representing work-queue hints.\n- A `Task.input` element slice representing the types of documents to be returned using the extensible LOINC® Document types value set.\n- A `Task.input` element slice representing a flag to indicate whether the requested data requires a signature.\n- A `Task.input` element slice representing the purpose of use for the requested data using an extensible *CDex Purpose of Use Value Set*.",
"exampleBoolean": false
}, {
"name": "CDex Purpose of Use Value Set",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
} ],
"reference": {
"reference": "ValueSet/cdex-POU"
},
"description": "The set of purpose of use codes for the requested data (the output of the task). This code set is composed [FHIR core Purpose of Use security labels](http://hl7.org/fhir/security-labels.html#core) and additional codes defined by this Guide.",
"exampleBoolean": false
}, {
"name": "CDex Attachment Reason Value Set",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
} ],
"reference": {
"reference": "ValueSet/cdex-attachment-reason"
},
"description": "The set of codes is used in the [`$submit-attachment`](http://build.fhir.org/ig/HL7/davinci-ecdx/OperationDefinition-attachment.html) operation for identifying the reason for attachments",
"exampleBoolean": false
}, {
"name": "CDex Work Queue Value Set",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "ValueSet"
} ],
"reference": {
"reference": "ValueSet/cdex-work-queue"
},
"description": "The set work queue tags that the provider may use in their workflow to process request. This code set is composed of codes defined by this Guide.",
"exampleBoolean": false
}, {
"name": "CDEX Document with Digital Signature Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Bundle"
} ],
"reference": {
"reference": "Bundle/cdex-document-digital-sig-example"
},
"description": "Digital signature example showing how it is used to sign a FHIR Document. The CDEX use case would be the target resource in response to a Task-based request where an digital signature was required. If no signature was required, the response would typically be in the form of an individual resource.",
"exampleBoolean": true
}, {
"name": "CDEX Document with Electronic Signature Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Bundle"
} ],
"reference": {
"reference": "Bundle/cdex-electronic-sig-example"
},
"description": "Electronic signature example showing how a image file can be use to sign a document Bundle. The CDEX use case would be the target resource in response to a Task-based request where an electronic signature was required. If no signature was required, the response would typically be in the form of an individual resource.",
"exampleBoolean": true
}, {
"name": "Scenario 2 Completed Authorization Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example1-authorized-completed"
},
"description": "Completed Task to seek a patient active conditions with a reference to a formal authorization.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "Scenario 2 Authorization Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example1-authorized-request"
},
"description": "Task to seek a patient active conditions with a reference to a formal authorization.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "Scenario 1 Completed Free Text Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example1-free-text-completed"
},
"description": "Completed Task to seek a patient active conditions using free text for the input.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "Scenario 1 Free Text Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example1-free-text-request"
},
"description": "Task to seek a patient active conditions using free text for the input.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "Scenario 1 Contained Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example1-query-completed-contained"
},
"description": "Completed Task to seek a patient active conditions using a contained resource for the output data.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "Scenario 1 Completed Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example1-query-completed"
},
"description": "Completed Task to seek a patient active conditions.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "Scenario 1 Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example1-query-requested"
},
"description": "Task to seek a patient active conditions.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "Scenario 1P Completed Free Text Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example1p-free-text-completed"
},
"description": "Completed Task to seek a patient active conditions and their provenance using free text for the input.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "Scenario 1P Completed Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example1p-query-completed"
},
"description": "Completed Task to seek a patient active conditions their provenance.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "Example of Task Request for Signed Data",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example1s-query-requested-withsig"
},
"description": "Task to seek a patient active conditions using `Task.input` signature parameter to indicate a signature is required.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "Example of Completed Task Request for Signed Data",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example1s-query-withsig-completed"
},
"description": "Completed Task to seek a *signed* patient active conditions.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "Scenario 3 Failed Task Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example2-query-failed"
},
"description": "Task to seek a patient's HbA1c test results with a failed status.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "Scenario 3 Task Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example2-query-requested"
},
"description": "Task to seek a patient's HbA1c test results.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "Scenario 4 Completed Task Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example3-query-completed"
},
"description": "Completed Task to seek a patient's latest history and physical exam notes using a contained resource for the output data.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "Scenario 4 Task Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Task"
} ],
"reference": {
"reference": "Task/cdex-example3-query-requested"
},
"description": "Task to seek a patient's latest history and physical exam notes.",
"exampleCanonical": "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request"
}, {
"name": "CDEX SearchSet Bundle with Digital Signature Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Bundle"
} ],
"reference": {
"reference": "Bundle/cdex-searchset-digital-sig-example"
},
"description": "Digital signature example showing how it is used to sign a searchset Bundle. The CDEX use case would be a response to a Direct Query where an digital signature was required.",
"exampleBoolean": true
}, {
"name": "CDex Submit Attachment Parameters Resource Example",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString": "Parameters"
} ],
"reference": {
"reference": "Parameters/cdex-submit-attachment-example"
},
"description": "Parameters Resource example showing how it is used when the `$submit-attachment` operation is invoked. It represents the collection of named parameters including the \"attachment\" (additional information) and data to re-associate the attachmenet to a claim or prior authorization.",
"exampleBoolean": true
} ],
"parameter": [ {
"code": "copyrightyear",
"value": "2022+"
}, {
"code": "releaselabel",
"value": "STU R1"
}, {
"code": "path-resource",
"value": "input/resources"
}, {
"code": "path-resource",
"value": "fsh-generated/resources"
}, {
"code": "path-pages",
"value": "input/pagecontent"
}, {
"code": "path-pages",
"value": "input/intro-notes"
}, {
"code": "path-pages",
"value": "fsh-generated/includes"
}, {
"code": "path-expansion-params",
"value": "../../input/_resources/exp-params.json"
}, {
"code": "active-tables",
"value": "false"
}, {
"code": "apply-contact",
"value": "true"
}, {
"code": "apply-jurisdiction",
"value": "true"
}, {
"code": "apply-publisher",
"value": "true"
}, {
"code": "apply-version",
"value": "true"
}, {
"code": "show-inherited-invariants",
"value": "false"
}, {
"code": "usage-stats-opt-out",
"value": "true"
}, {
"code": "excludexml",
"value": "false"
}, {
"code": "excludejsn",
"value": "false"
}, {
"code": "excludettl",
"value": "true"
}, {
"code": "excludemap",
"value": "true"
}, {
"code": "excludeexample",
"value": "true"
}, {
"code": "generate",
"value": "xml"
}, {
"code": "generate",
"value": "json"
}, {
"code": "path-history",
"value": "http://hl7.org/fhir/us/davinci-cdex/history.html"
}, {
"code": "autoload-resources",
"value": "true"
}, {
"code": "path-resource",
"value": "input/capabilities"
}, {
"code": "path-resource",
"value": "input/examples"
}, {
"code": "path-resource",
"value": "input/extensions"
}, {
"code": "path-resource",
"value": "input/models"
}, {
"code": "path-resource",
"value": "input/operations"
}, {
"code": "path-resource",
"value": "input/profiles"
}, {
"code": "path-resource",
"value": "input/vocabulary"
}, {
"code": "path-resource",
"value": "input/testing"
}, {
"code": "path-resource",
"value": "input/history"
}, {
"code": "path-pages",
"value": "template/config"
}, {
"code": "path-pages",
"value": "input/images"
}, {
"code": "path-liquid",
"value": "template/liquid"
}, {
"code": "path-liquid",
"value": "input/liquid"
}, {
"code": "path-qa",
"value": "temp/qa"
}, {
"code": "path-temp",
"value": "temp/pages"
}, {
"code": "path-output",
"value": "output"
}, {
"code": "path-tx-cache",
"value": "input-cache/txcache"
}, {
"code": "path-suppressed-warnings",
"value": "input/ignoreWarnings.txt"
}, {
"code": "template-html",
"value": "template-page.html"
}, {
"code": "template-md",
"value": "template-page-md.html"
}, {
"code": "apply-context",
"value": "true"
}, {
"code": "apply-copyright",
"value": "true"
}, {
"code": "apply-license",
"value": "true"
}, {
"code": "fmm-definition",
"value": "http://hl7.org/fhir/versions.html#maturity"
}, {
"code": "propagate-status",
"value": "true"
} ]
},
"date": "2021-12-13",
"publisher": "HL7 International - Patient Care Work Group",
"fhirVersion": [ "4.0.1" ],
"license": "CC0-1.0",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"dependsOn": [ {
"id": "uscore",
"uri": "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core",
"version": "3.1.1",
"packageId": "hl7.fhir.us.core"
}, {
"id": "hrex",
"uri": "http://hl7.org/fhir/us/davinci-hrex/ImplementationGuide/hl7.fhir.us.davinci-hrex",
"version": "1.0.0",
"packageId": "hl7.fhir.us.davinci-hrex"
}, {
"id": "pas",
"uri": "http://hl7.org/fhir/us/davinci-pas/ImplementationGuide/hl7.fhir.us.davinci-pas",
"version": "1.1.0",
"packageId": "hl7.fhir.us.davinci-pas"
} ],
"name": "DaVinciCDex",
"copyright": "Used by permission of HL7 International all rights reserved Creative Commons License",
"type": null,
"experimental": null,
"resourceType": "ImplementationGuide",
"title": "Da Vinci Clinical Data Exchange (CDex)",
"package_version": "cdex-1.0.0",
"status": "active",
"id": "63b06d45-fa65-4256-9a3c-7d2369d473c4",
"kind": null,
"url": "http://hl7.org/fhir/us/davinci-cdex/ImplementationGuide/hl7.fhir.us.davinci-cdex",
"version": "1.0.0",
"packageId": "hl7.fhir.us.davinci-cdex",
"contact": [ {
"name": "HL7 International - Patient Care Work Group",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/patientcare",
"system": "url"
}, {
"value": "patientcare@lists.HL7.org",
"system": "email"
} ]
} ]
}