| Package | hl7.fhir.us.davinci-cdex |
| Type | CapabilityStatement |
| Id | data-consumer-server |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/davinci-cdex/https://build.fhir.org/ig/HL7/davinci-ecdx/CapabilityStatement-data-consumer-server.html |
| URL | http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-consumer-server |
| Version | 2.1.0 |
| Status | active |
| Date | 2024-10-22T19:20:55.756836-08:00 |
| Name | DataConsumerServerCapabilityStatement |
| Title | Data Consumer Server CapabilityStatement |
| Realm | us |
| Authority | hl7 |
| Description | This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Consumer in *Server* mode when responding to a Data Source or one of its proxies during clinical data exchange. The capabilities include one or more of the following interactions: 1. Responding to a query for authorization information represented by a CommunicationRequest or ServiceRequest 1. Responding to the `$submit-attachment` operation. |
| Copyright | Used by permission of HL7 International all rights reserved Creative Commons License |
| Kind | requirements |
No resources found
| ImplementationGuide | |
| hl7.fhir.us.davinci-hrex | Da Vinci Health Record Exchange (HRex) |
| hl7.fhir.us.core | US Core Implementation Guide |
| OperationDefinition | |
| submit-attachment | Submit Attachment Operation |
| StructureDefinition | |
| cdex-sdc-questionnaireresponse | CDex SDC QuestionnaireResponse Profile |
| us-core-documentreference | US Core DocumentReference Profile |
Note: links and images are rebased to the (stated) source
The Da Vinci CDex Data Consumer Server SHALL:
The Da Vinci CDex Data Consumer Server MAY:
Support XML source formats for all Da Vinci CDex interactions.
Implementers that choose to support XML need to be aware that JSON Web Signatures can only be created and validated in the original native JSON. Transforms to and from XML will invalidate signatures.
Security:
Summary of System Wide Interactions
FHIRtransaction interaction.batch interaction.search-system interaction.history-system interaction.Summary of System Wide Operations
$submit-attachment operation.If Attachments is supported, the Data Consumer Server SHALL support the
$submit-attachmentoperation.
| Resource Type | Supported Profiles | Supported Searches | Supported _includes | Supported _revincludes | Supported Operations |
|---|---|---|---|---|---|
| CommunicationRequest | - | - | - | - | - |
| DocumentReference | , , | - | - | - | - |
| Parameters | - | - | - | - | - |
| QuestionnaireResponse | CDex SDC QuestionnaireResponse Profile | - | - | - | - |
| ServiceRequest | - | - | - | - | - |
Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to carry authorization information regarding for requesting Clinical information
Profile Interaction Summary:
search-type, read†, vread.create, update, patch, delete, history-instance, history-type.read†Either a CommunicationRequest or ServiceRequest is required if an Authorization is required for a particular clinical data exchange scenario
Fetch and Search Criteria:
GET [base]/CommunicationRequest/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to support the
$submit-attachmentoperation
Supported Profiles:
Profile Interaction Summary:
create, read, vread, update.search-type, patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/DocumentReference/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to support the
$submit-attachmentoperation
Profile Interaction Summary:
search-type, read, vread.create, update, patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/Parameters/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to support the
$submit-attachmentoperation for Requesting Attachments Using Questionnaires. SHALL* support CDex SDC QuestionnaireResponse Profile for signed QuestionnaireResponse.
Supported Profiles:
Profile Interaction Summary:
search-type, read, vread.create, update, patch, delete, history-instance, history-type.Fetch and Search Criteria:
GET [base]/QuestionnaireResponse/[id] Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to carry authorization information regarding for requesting Clinical information
Profile Interaction Summary:
search-type, read†, vread.create, update, patch, delete, history-instance, history-type.read†Either a CommunicationRequest or ServiceRequest is required if an Authorization is required for a particular clinical data exchange scenario
Fetch and Search Criteria:
GET [base]/ServiceRequest/[id] {
"resourceType": "CapabilityStatement",
"id": "data-consumer-server",
"text": {
"status": "additional",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "claims"
}
],
"url": "http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-consumer-server",
"version": "2.1.0",
"name": "DataConsumerServerCapabilityStatement",
"title": "Data Consumer Server CapabilityStatement",
"status": "active",
"experimental": false,
"date": "2024-10-22T19:20:55.756836-08:00",
"publisher": "HL7 International / Payer/Provider Information Exchange Work Group",
"contact": [
{
"name": "HL7 International / Payer/Provider Information Exchange Work Group",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/claims"
},
{
"system": "email",
"value": "pie@lists.hl7.org"
}
]
}
],
"description": "This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Consumer in *Server* mode when responding to a Data Source or one of its proxies during clinical data exchange. The capabilities include one or more of the following interactions:\n\n1. Responding to a query for authorization information represented by a CommunicationRequest or ServiceRequest\n1. Responding to the `$submit-attachment` operation.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"copyright": "Used by permission of HL7 International all rights reserved Creative Commons License",
"kind": "requirements",
"fhirVersion": "4.0.1",
"format": [
"json",
"xml"
],
"_format": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
]
}
],
"patchFormat": [
"application/json-patch+json"
],
"_patchFormat": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
]
}
],
"implementationGuide": [
"http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|3.1.1",
"http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|6.1.0",
"http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|7.0.0",
"http://hl7.org/fhir/us/davinci-hrex/ImplementationGuide/hl7.fhir.us.davinci-hrex|1.1.0"
],
"_implementationGuide": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"rest": [
{
"mode": "server",
"documentation": "The Da Vinci CDex Data Consumer Server **SHALL**:\n\n 1. Support at least one of the CDex approaches for exchanging clinical information:\n 1. Task Based Approach\n 1. Attachments\n1. Follow the guidelines for [Generating and Verifying Signed Resources](signatures.html) *if signatures are required*.\n1. Support JSON source formats for all Da Vinci CDex interactions.\n1. Declare a CapabilityStatement identifying the scenarios, transactions and profiles supported.\n - Follow the guidelines for [Conforming to CDex Attachments](attachments-conformance.html) if supporting this exchange.\n\nThe Da Vinci CDex Data Consumer Server **MAY**:\n\n1. Support XML source formats for all Da Vinci CDex interactions.\n \n > Implementers that choose to support XML need to be aware that JSON Web Signatures can only be created and validated in the original native JSON. Transforms to and from XML will invalidate signatures.",
"security": {
"description": "1. For general security consideration refer to the FHIR [Security and Privacy Considerations](http://build.fhir.org/secpriv-module.html). \n1. For security considerations specific to this guide refer to the [Security and Privacy](security.html) section."
},
"resource": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "CommunicationRequest",
"documentation": "Required resource type to carry authorization information regarding for requesting Clinical information",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "read",
"documentation": "Either a CommunicationRequest or ServiceRequest is required if an Authorization is required for a particular clinical data exchange scenario"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "DocumentReference",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|3.1.1",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|6.1.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|7.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
]
}
],
"documentation": "Required resource type to support the `$submit-attachment` operation",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "Parameters",
"documentation": "Required resource type to support the `$submit-attachment` operation",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "QuestionnaireResponse",
"supportedProfile": [
"http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-sdc-questionnaireresponse|2.1.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"documentation": "Required resource type to support the `$submit-attachment` operation for Requesting Attachments Using Questionnaires. *SHALL** support CDex SDC QuestionnaireResponse Profile for signed QuestionnaireResponse.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "ServiceRequest",
"documentation": "Required resource type to carry authorization information regarding for requesting Clinical information",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "read",
"documentation": "Either a CommunicationRequest or ServiceRequest is required if an Authorization is required for a particular clinical data exchange scenario"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
]
}
],
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "transaction"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "batch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "search-system"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-system"
}
],
"operation": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "submit-attachment",
"definition": "http://hl7.org/fhir/us/davinci-cdex/OperationDefinition/submit-attachment",
"documentation": "If [Attachments](attachments.html) is supported, the Data Consumer Server **SHALL** support the `$submit-attachment` operation."
}
]
}
]
}