# ╭──────────────────────────────────────ImplementationGuide───────────────────────────────────────╮ # │ The properties below are used to create the ImplementationGuide resource. For a list of │ # │ supported properties, see: https://fshschool.org/sushi/configuration/ │ # ╰────────────────────────────────────────────────────────────────────────────────────────────────╯ id: hl7.fhir.us.davinci-cdex extension: - url: >- http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status valueCode: trial-use - url: 'http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm' valueInteger: 2 - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg valueCode: claims definition: extension: - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency #<<<<< these are to inform the publisher link checker that links to this IG mostly in the change log are valid valueCode: hl7.fhir.us.davinci-cdex#2.0.0 - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency #<<<<< these are to inform the publisher link checker that links to this IG mostly in the change log are valid valueCode: hl7.fhir.us.davinci-cdex#2.0.0-ballot - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency valueCode: hl7.fhir.us.davinci-cdex#1.1.0 - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency valueCode: hl7.fhir.us.davinci-cdex#1.0.0 - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency valueCode: hl7.fhir.us.davinci-cdex#0.2.0 - url: http://hl7.org/fhir/tools/StructureDefinition/ig-link-dependency valueCode: hl7.fhir.us.davinci-cdex#0.1.0 canonical: http://hl7.org/fhir/us/davinci-cdex name: DaVinciCDex title: Da Vinci Clinical Data Exchange (CDex) status: active publisher: name: HL7 International / Payer/Provider Information Exchange Work Group url: 'http://www.hl7.org/Special/committees/claims' email: pie@lists.hl7.org jurisdiction: 'urn:iso:std:iso:3166#US' copyright: >- Used by permission of HL7 International all rights reserved Creative Commons License 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). license: CC0-1.0 date: '2024-11-01' version: 2.1.0 fhirVersion: 4.0.1 dependencies: hl7.fhir.us.core: version: 7.0.0 uri: http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core id: uscore7 reason: | Needed for systems supporting USCDI v4 hl7.fhir.us.core.v610: version: 6.1.0 uri: http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core id: uscore6 reason: | Needed for systems supporting USCDI v3 hl7.fhir.us.core.v311: version: 3.1.1 uri: http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core id: uscore3 reason: | Needed for systems supporting USCDI v1 hl7.fhir.us.davinci-hrex: uri: 'http://hl7.org/fhir/us/davinci-hrex/ImplementationGuide/hl7.fhir.us.davinci-hrex' version: 1.1.0 id: hrex hl7.fhir.us.davinci-pas: uri: 'http://hl7.org/fhir/us/davinci-pas/ImplementationGuide/hl7.fhir.us.davinci-pas' version: 2.1.0 id: pas hl7.fhir.us.carin-bb: uri: 'http://hl7.org/fhir/us/carin-bb/ImplementationGuide/hl7.fhir.us.carin-bb' version: 2.0.0 id: c4bb hl7.fhir.us.davinci-dtr: uri: 'http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr' version: 2.1.0 id: dtr hl7.fhir.uv.sdc: uri: 'http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc' version: 3.0.0 id: sdc hl7.fhir.extensions.r4: version: 4.0.1 hl7.fhir.uv.subscriptions-backport.r4: version: 1.1.0 uri: http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport id: backport # Groups can control certain aspects of the IG generation. The IG # documentation recommends that authors use the default groups that # are provided by the templating framework, but if authors want to # use their own instead, they can use the mechanism below. This will # create IG.definition.grouping entries and associate the individual # resource entries with the corresponding groupIds. groups: CapabilityStatements: name: CDex Capability Statements description: The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements. resources: - CapabilityStatement/data-consumer-client - CapabilityStatement/data-consumer-server - CapabilityStatement/data-source-client - CapabilityStatement/data-source-server AttachmentsProfiles: name: Attachments Profiles description: Profiles Associated with CDex Attachments Transactions resources: - StructureDefinition/cdex-task-attachment-request - StructureDefinition/cdex-practitionerrole - StructureDefinition/cdex-patient-demographics - StructureDefinition/cdex-parameters-submit-attachment AttachmentsOperations: name: Attachments Operations description: Operations Associated with CDex Attachments Transactions resources: - OperationDefinition/submit-attachment AttachmentsTerminology: name: Attachments Terminology description: ValueSets Associated with CDex Attachments Transactions resources: - ValueSet/cdex-claim-use - ValueSet/cdex-loinc-attachment-codes - ValueSet/cdex-pwk01-attachment-report-type-code AttachmentsExamples: name: Attachments Examples description: Examples Associated with CDex Attachments Transactions (see also "Signature Examples" below) resources: - Task/cdex-task-example19 - Task/cdex-task-example20 - Task/cdex-task-example22 - Task/cdex-task-example23 - Task/cdex-task-example24 - Task/cdex-task-example25 - Task/cdex-task-example28 - Task/cdex-task-example29 - Parameters/cdex-parameters-example1 # - Parameters/cdex-parameters-example2 - Parameters/cdex-parameters-example3 - Parameters/cdex-parameters-example4 - Parameters/cdex-parameters-example5 TaskBasedProfiles: name: Task Based Approach Profiles description: Profiles Associated with CDex Task Based Approach Transactions resources: - StructureDefinition/cdex-task-data-request TaskBasedTerminology: name: Task Based Approach Terminology description: ValueSets Associated with CDex Task Based Approach Transactions resources: - ValueSet/cdex-work-queue - ValueSet/cdex-data-request-task-code # TaskBasedSubscriptionTopic: # name: Task Based Subscription Topic # description: Basic resource representing the subscription for Task updates # resources: # - SubscriptionTopic/cdex-task-update TaskBasedExamples: name: Task Based Approach Examples description: Examples Associated with CDex Task Based Approach Transactions resources: - Task/cdex-task-example1 - Task/cdex-task-example2 - Task/cdex-task-example3 - Task/cdex-task-example4 - Task/cdex-task-example5 - Task/cdex-task-example6 - Task/cdex-task-example7 - Task/cdex-task-example8 - Task/cdex-task-example9 - Task/cdex-task-example10 - Task/cdex-task-example11 - Task/cdex-task-example12 - Task/cdex-task-example13 - Task/cdex-task-example14 - Task/cdex-task-example15 - Task/cdex-task-example16 - Task/cdex-task-example17 - Task/cdex-task-example18 - Task/cdex-task-example21 - Task/cdex-task-example26 - Task/cdex-task-example27 - Task/cdex-task-example30 - Task/cdex-task-example31 DirectQueryExamples: name: Direct Query Examples description: Examples Associated with CDex Direct Query (FHIR RESTful search) Approach Transactions resources: - Bundle/cdex-searchbundle-scenario1-example - Bundle/cdex-searchbundle-provenance-example - Bundle/cdex-searchbundle-scenario3-example - Bundle/cdex-searchbundle-scenario2-example # QuestionnaireProfiles: # name: Questionnaire Profiles # description: Questionnaire profiles used in both CDex Attachments and Task Based Approach Transactions # resources: # - StructureDefinition/cdex-sdc-questionnaireresponse QuestionnaireExamples: name: Questionnaire Examples description: Questionnaire examples used in both CDex Attachments and Task Based Approach Transaction (see also "Signature Examples" below) resources: - Questionnaire/cdex-questionnaire-example1 - QuestionnaireResponse/cdex-questionnaireresponse-example1 - QuestionnaireResponse/cdex-questionnaireresponse-example2 SignatureProfiles: name: Signature Profiles description: Profiles Associated with CDex Signatures resources: - StructureDefinition/cdex-digital-signature - StructureDefinition/cdex-signature-bundle - StructureDefinition/cdex-sdc-questionnaireresponse SignatureTerminology: name: Signature Terminology description: ValueSets Associated with CDex Signatures resources: - ValueSet/cdex-identifier-types SignatureExamples: name: Signature Examples description: Examples Associated with CDex Signatures resources: - Bundle/cdex-searchbundle-digital-sig-example - Bundle/cdex-document-digital-sig-example - Bundle/cdex-electronic-sig-example - Parameters/cdex-parameters-example2 - Questionnaire/cdex-questionnaire-example2 - QuestionnaireResponse/cdex-questionnaireresponse-example3 - QuestionnaireResponse/cdex-questionnaireresponse-example4 CommonTerminology: name: Common Terminology description: ValueSets and CodeSystems used in both CDex Attachments and Task Based Approach Transactions resources: - ValueSet/cdex-POU - CodeSystem/cdex-temp InlineExamples: name: Inline Examples description: These examples are used in the inline example scenarios throughout the guide. They are listed here so the implementation guide's publication tooling can validate them against the CDex profile definitions. Since they are used to illustrate "over-the-wire" transactions, the rendered narrative and id elements are often absent. resources: - Task/cdex-task-inline-example1 - Task/cdex-task-inline-example4 - Task/cdex-task-inline-example6 - Task/cdex-task-inline-example21 - Task/cdex-task-inline-example10 - Task/cdex-task-inline-example11 - Task/cdex-task-inline-example13 - Task/cdex-task-inline-example15 - Task/cdex-task-inline-example17 - Task/cdex-task-inline-example19 - Task/cdex-task-inline-example22 # updated version of 26 are inline in scenario 10 and not validated - Task/cdex-task-inline-example26 # updated version of 26 are inline in scenario 10 and not validated - Subscription/cdex-task-inline-scenario1-subscription-requested - Subscription/cdex-task-inline-scenario1-subscription-active - Bundle/cdex-task-inline-scenario1-subscription-notification - Bundle/cdex-bundle-inline-example-858p - Condition/cdex-condition-inline-example-858 - Provenance/cdex-provenance-inline-example-858 - CommunicationRequest/cdex-task-inline-communicationrequest-example1 - QuestionnaireResponse/cdex-questionnaireresponse-inline-example1 - OperationOutcome/cdex-operationoutcome-inline-example1 - CapabilityStatement/cdex-capabilitystatement-inline-example pages: index.md: # extension: # - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status # valueCode: trial-use title: IG Home background.md: extension: - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status valueCode: trial-use # specification.md: # exchanging-clinical-data.md: direct-query.md: extension: - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status valueCode: trial-use task-based-approach.md: extension: - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status valueCode: trial-use task-based-conformance.md: extension: - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status valueCode: trial-use title: Conforming to CDex Task Based Approach attachments.md: # extension: # - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status # valueCode: trial-use solicited-unsolicited-attachments.md: # extension: # - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status # valueCode: trial-use title: Solicited and Unsolicited Attachments sending-attachments.md: extension: - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status valueCode: trial-use requesting-attachments-code.md: extension: - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status valueCode: trial-use title: Requesting Attachments Using Attachments Codes requesting-attachments-questionnaire.md: extension: - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status valueCode: trial-use title: Requesting Attachments Using Questionnaires burden-reduction.md: # extension: # - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status # valueCode: trial-use title: Using CDex Attachments with DaVinci PAS attachments-conformance.md: extension: - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status valueCode: trial-use title: Conforming to CDex Attachments signatures.md: extension: - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status valueCode: trial-use signed-searchset-bundle-example.md: extension: - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status valueCode: informative title: 'Worked Example: Signed Searchset Bundle' signed-document-bundle-example.md: extension: - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status valueCode: informative title: 'Worked Example: Signed Document Bundle' security.md: extension: - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status valueCode: trial-use title: Security and Privacy downloads.md: # extension: # - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status # valueCode: trial-use ImplementationGuide-hl7.fhir.us.davinci-cdex.md: # extension: # - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status # valueCode: trial-use title: CDex ImplementationGuide Resource changes.md: # extension: # - url: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status # valueCode: trial-use title: Change Log parameters: path-resource: - input/resources - fsh-generated/resources - input/examples # - input/fexamples-inline path-pages: - input/pagecontent - input/intro-notes - fsh-generated/includes path-expansion-params: '../../input/_resources/exp-params.json' # for using US ed of SNOMED # path-liquid: # list of relative paths that contains liquid templates for generating narrative # - liquid active-tables: 'false' apply-contact: 'true' apply-jurisdiction: 'true' apply-publisher: 'true' apply-version: 'true' show-inherited-invariants: 'false' usage-stats-opt-out: 'true' # excludexml: 'false' # excludejson: 'false' excludettl: 'true' # excludemap: 'true' # excludeexample: 'true' generate: - xml - json version-comparison: - 1.0.0 - 1.1.0 - 2.0.0 bundle-references-resolve: false no-narrative: - Parameters/cdex-parameters-example4 - Parameters/cdex-parameters-example5 - Parameters/cdex-parameters-example1 - Parameters/cdex-parameters-example2 - Parameters/cdex-parameters-example3 - Task/cdex-task-inline-example1 - Task/cdex-task-inline-example4 - Task/cdex-task-inline-example6 - Task/cdex-task-inline-example21 - Task/cdex-task-inline-example22 - Task/cdex-task-inline-example26 - Task/cdex-task-inline-example10 - Task/cdex-task-inline-example11 - Task/cdex-task-inline-example13 - Task/cdex-task-inline-example15 - Task/cdex-task-inline-example17 - Task/cdex-task-inline-example19 - Subscription/cdex-task-inline-scenario1-subscription-requested - Subscription/cdex-task-inline-scenario1-subscription-active - QuestionnaireResponse/cdex-questionnaireresponse-inline-example1 - Bundle/cdex-task-inline-scenario1-subscription-notification - Bundle/cdex-bundle-inline-example-858p suppressed-ids: Parameters/cdex-parameters-example1,Parameters/cdex-parameters-example2,Parameters/cdex-parameters-example3,Parameters/cdex-parameters-example4,Parameters/cdex-parameters-example5,Task/cdex-task-inline-example1,Subscription/cdex-task-inline-scenario1-subscription-requested,Task/cdex-task-inline-example4,Task/cdex-task-inline-example6,Task/cdex-task-inline-example21,Task/cdex-task-inline-example10,Task/cdex-task-inline-example11,Task/cdex-task-inline-example13,Task/cdex-task-inline-example15,Task/cdex-task-inline-example17,Task/cdex-task-inline-example26,QuestionnaireResponse/cdex-questionnaireresponse-inline-example1,Task/cdex-task-inline-example19,Task/cdex-task-inline-example22,OperationOutcome/cdex-operationoutcome-inline-example1 tabbed-snapshots: 'true' auto-oid-root: '2.16.840.1.113883.4.642.40.21' copyrightyear: '2024+' # releaselabel: CI Build releaselabel: STU 2.1 # releaselabel: Ballot # ╭────────────────────────────────────────────menu.xml────────────────────────────────────────────╮ # │ To use a provided ig-data/input/includes/menu.xml file, delete the "menu" property below. │ # ╰────────────────────────────────────────────────────────────────────────────────────────────────╯ menu: IG Home: #index.html Introduction: index.html About This Guide: index.html#about-this-guide How to read this Guide: index.html#how-to-read-this-guide Credits: index.html#credits Background: # background.html About the Da Vinci Project: background.html What Do Payers Do with Clinical Information: background.html#what-do-payers-do-with-clinical-information Provider to Provider Data Exchange: background.html#provider-to-provider-data-exchange What Information is Needed: background.html#what-information-is-needed Where Does CDEX Fit in the Da Vinci Project: background.html#where-does-cdex-fit-in-the-da-vinci-project Workflow Overview: background.html#workflow-overview Architectural Approach: background.html#architectural-approach Direct Query: # direct-query.html Introduction: direct-query.html Benefits: direct-query.html#benefits Sequence Diagram: direct-query.html#sequence-diagram Discovery of Patient FHIR IDs: direct-query.html#discovery-of-patient-fhir-ids Direct Query Transaction Scenarios: direct-query.html#direct-query-transaction-scenarios Provenance: direct-query.html#provenance Signatures: direct-query.html#signatures Task Based Approach: #task-based-approach.html Introduction: task-based-approach.html Benefits: task-based-approach.html#benefits The Task Resource: task-based-approach.html#the-task-resource Sequence Diagram: task-based-approach.html#sequence-diagram Discovery of Identifiers: task-based-approach.html#discovery-of-identifiers Task State Machine: task-based-approach.html#task-state-machine Fetching the Data: task-based-approach.html#fetching-the-data Task Based Transaction Scenarios: task-based-approach.html#example-transactions-based-on-query-code-and-free-text-inputs Using Questionnaire as Task Input: task-based-approach.html#using-questionnaire-as-task-input When The Task Cannot Be Completed: task-based-approach.html#when-the-task-cannot-be-completed Polling vs Subscriptions: task-based-approach.html#polling-vs-subscriptions Formal Authorization: task-based-approach.html#formal-authorization Provenance: task-based-approach.html#provenance Signatures: task-based-approach.html#signatures Conforming to CDex Task Based Approach: task-based-conformance.html Attachments: Solicited and Unsolicited Attachments: solicited-unsolicited-attachments.html Sending Attachments: sending-attachments.html Requesting Attachments Using Attachment Codes: requesting-attachments-code.html Requesting Attachments Using Questionnaires: requesting-attachments-questionnaire.html Using CDex Attachments with DaVinci PAS: burden-reduction.html Conforming to CDex Attachments: attachments-conformance.html Signatures: # signatures.html About Signatures: signatures.html The Signer: signatures.html#the-signer What is Signed: signatures.html#what-is-signed CDex Signatures: signatures.html#cdex-signatures Electronic Signatures: signatures.html#electronic-signatures Digital Signatures: signatures.html#digital-signatures Security and Privacy: security.html FHIR Artifacts: Artifacts Summary: artifacts.html CDex Capability Statements: artifacts.html#1 Attachments Profiles: artifacts.html#2 Attachments Operations: artifacts.html#3 Attachments Terminology: artifacts.html#4 Attachments Examples: artifacts.html#5 Task Based Approach Profiles: artifacts.html#6 Task Based Approach Terminology: artifacts.html#7 Task Based Approach Examples: artifacts.html#8 Direct Query Examples: artifacts.html#9 # Questionnaire Profiles: artifacts.html#10 Questionnaire Examples: artifacts.html#10 Signature Profiles: artifacts.html#11 Signature Terminology: artifacts.html#12 Signature Examples: artifacts.html#13 Common Terminology: artifacts.html#14 Inline Examples: artifacts.html#15 Support: Discussion Forum: https://chat.fhir.org/#narrow/stream/180805-Da-Vinci-CDex Project Page: https://confluence.hl7.org/pages/viewpage.action?pageId=40738757 Implementer Support: https://confluence.hl7.org/display/DVP/CDex+Implementer+Support?src=contextnavpagetreemode Specification Dashboard: https://jira.hl7.org/secure/Dashboard.jspa?selectPageId=11801 Propose a Change: https://jira.hl7.org/secure/ Downloads: downloads.html Change Log: changes.html