Da Vinci Clinical Data Exchange (CDex), published by HL7 International / Payer/Provider Information Exchange Work Group. This guide is not an authorized publication; it is the continuous build for version 2.1.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-ecdx/ and changes regularly. See the Directory of published versions
Page standards status: Informative |
{
"resourceType" : "CapabilityStatement",
"id" : "cdex-capabilitystatement-inline-example",
"meta" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/instance-name",
"valueString" : "CDex Capabilitystatement Inline Example"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/instance-description",
"valueMarkdown" : "Capabilitystatement example used to create inline example to demonstrate using the CapabilityStatement SubscriptionTopic Canonical] extension to advertise the canonical URLs of topics available to clients"
}
]
},
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <!-- TODO \n Jurisdiction \n Prohibited extension - http://hl7.org/fhir/StructureDefinition/capabilitystatement-prohibited -->\n <!-- set include_symbols = false to turn off confonrmance symbols and legen, true to turn on -->\n \n \n <h2 id=\"title\"/>\n <ul>\n \n <li><b>Implementation Guide Version:</b> 2.1.0-preview</li>\n <li><b>FHIR Version:</b> 4.0.1</li>\n <li><b>Intended Use:</b> requirements</li>\n <li><b>Supported Formats: </b> \n\n \n \n \n json;\n \n\n </li>\n \n <li><b>Published:</b> 2024-05-16</li>\n \n <li><b>Published by:</b> HL7 International / Payer/Provider Information Exchange Work Group</li>\n <li><b>Status:</b> active</li>\n <li><b>Copyright:</b> <div><p>Used by permission of HL7 International all rights reserved Creative Commons License</p>\n</div></li>\n </ul>\n <br/>\n\n\n\n \n <strong>Description:</strong> <div><div><p>R4 example of a CapabilityStatement advertising support for CDex Task Update topic-based subscription</p>\n</div></div>\n \n <br/>\n \n \n\n\n \n <h3>Support and Requirements for Other Artifacts</h3>\n \n <tr>\n <th>Instantiates other capabilities:</th>\n <td>\n <ul>\n \n <li>\n \n <a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/CapabilityStatement-backport-subscription-server-r4.html\">BackportSubscriptionCapabilityStatementR4</a>\n </li>\n \n </ul>\n </td>\n </tr>\n \n \n \n <tr>\n <th>Supports other guides:</th>\n <td>\n <ul>\n \n <li>\n \n <a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/ImplementationGuide-hl7.fhir.uv.subscriptions-backport.html\">Subscriptions R5 Backport</a>\n </li>\n \n </ul>\n </td>\n </tr>\n \n \n\n <br/>\n <!-- TODO - Make this a summary of capabilities, including system wide and each paradigm -->\n <p>\n <b>Jump to:</b>\n </p>\n <ul>\n \n <li><a href=\"#server\">REST server</a></li>\n \n \n \n </ul>\n\n\n\n <!-- REST Capabilities -->\n \n <br/>\n <a name=\"server\"> </a>\n <h3 id=\"behavior\">FHIR server RESTful Capabilities</h3>\n \n\n <!-- REST Security -->\n \n\n <!-- REST System wide Capabilities -->\n \n <h3>System-wide server Capabilities</h3>\n \n <!-- REST System wide interactions -->\n \n\n <!-- REST System wide operations -->\n \n\n\n <!-- REST System wide search parameters -->\n \n \n\n\n\n <!-- Resource Capabilities -->\n \n\n <h4>Summary of Resource/Profile Capabilities</h4>\n <!-- TODO need include conformance verb legend -->\n \n <table class=\"grid\">\n <thead>\n <tr>\n <th>Resource Type</th>\n <th>Supported Interactions</th>\n <th>Supported Profiles</th>\n <th>Supported Searches</th>\n <th>Supported <code>_includes</code></th>\n <th>Supported <code>_revincludes</code></th>\n <th>Supported Operations</th>\n </tr>\n </thead>\n <tbody>\n \n <tr>\n <td>\n <a href=\"#server_Subscription\"><span style=\"white-space: nowrap;\">Subscription</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n <a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html\">R4/B Topic-Based Subscription</a>,\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">url</span>, \n \n \n <span style=\"white-space: nowrap;\">status</span>, \n \n \n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">$status</span>\n \n \n <span style=\"white-space: nowrap;\">$events</span>\n \n \n <span style=\"white-space: nowrap;\">$get-ws-binding-token</span>\n \n \n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#server_Patient\"><span style=\"white-space: nowrap;\">Patient</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#server_Encounter\"><span style=\"white-space: nowrap;\">Encounter</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#server_Observation\"><span style=\"white-space: nowrap;\">Observation</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n </td>\n </tr>\n \n </tbody>\n </table>\n <br/>\n\n <h3 id=\"resource-details\" class=\"no_toc\">RESTful server Capabilities by Resource/Profile:</h3>\n <!-- Each REST Resource Detail -->\n \n <h4 id=\"server_Subscription\" class=\"no_toc\">Subscription</h4>\n\n <p>Conformance Expectation:\t<strong/></p>\n\n \n\n \n\n <p>Supported Profiles:</p>\n <ul>\n \n <li>\n <a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html\">R4/B Topic-Based Subscription</a>\n </li>\n \n </ul>\n \n \n\n\n <p>\n \n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n <p>Subscription Interaction Summary:</p>\n <ul>\n \n \n \n \n \n <li> read, create, update, delete, </li>\n \n </ul>\n\n \n \n \n \n \n \n \n \n \n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n\n \n\n \n\n\n \n\n \n \n <li>\n A server <strong>(conformance expectation undefined)</strong> be capable of a <code>create</code> interaction creating a Subscription resource using:\n <code class=\"highlighter-rouge\">POST [base]/Subscription/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A server <strong>(conformance expectation undefined)</strong> be capable of updating a existing Subscription resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Subscription/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n <li>\n A server <strong>(conformance expectation undefined)</strong> be capable of deleting a Subscription resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n <li>\n A server <strong>(conformance expectation undefined)</strong> be capable of a <code>read</code> interaction returning a Subscription resource using:\n <code class=\"highlighter-rouge\">GET [base]/Subscription/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n\n \n\n </ul>\n \n\n \n <br/>\n <p>Search Parameter Summary:</p>\n <table class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- TODO, should the search paramaters be limited to only SHALL and SHOULD -->\n \n <tr>\n <td>\n <strong>(conformance expectation undefined)</strong>\n </td>\n <td>\n <a href=\"http://hl7.org/fhir/SearchParameter/Subscription-url\">url</a>\n </td>\n <td>\n uri\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Subscription?url=[uri]\n </code>\n </td>\n </tr>\n \n <tr>\n <td>\n <strong>(conformance expectation undefined)</strong>\n </td>\n <td>\n <a href=\"http://hl7.org/fhir/SearchParameter/Subscription-status\">status</a>\n </td>\n <td>\n token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Subscription?status=[system]|[code]\n </code>\n </td>\n </tr>\n \n </tbody>\n </table>\n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n <h4 id=\"server_Patient\" class=\"no_toc\">Patient</h4>\n\n <p>Conformance Expectation:\t<strong/></p>\n\n \n\n \n\n \n \n\n\n <p>\n \n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n\n \n\n \n\n\n \n\n \n \n <li>\n A server <strong>(conformance expectation undefined)</strong> be capable of a <code>create</code> interaction creating a Patient resource using:\n <code class=\"highlighter-rouge\">POST [base]/Patient/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A server <strong>(conformance expectation undefined)</strong> be capable of updating a existing Patient resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Patient/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n <li>\n A server <strong>(conformance expectation undefined)</strong> be capable of deleting a Patient resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n <li>\n A server <strong>(conformance expectation undefined)</strong> be capable of a <code>read</code> interaction returning a Patient resource using:\n <code class=\"highlighter-rouge\">GET [base]/Patient/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n <h4 id=\"server_Encounter\" class=\"no_toc\">Encounter</h4>\n\n <p>Conformance Expectation:\t<strong/></p>\n\n \n\n \n\n \n \n\n\n <p>\n \n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n\n \n\n \n\n\n \n\n \n \n <li>\n A server <strong>(conformance expectation undefined)</strong> be capable of a <code>create</code> interaction creating a Encounter resource using:\n <code class=\"highlighter-rouge\">POST [base]/Encounter/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A server <strong>(conformance expectation undefined)</strong> be capable of updating a existing Encounter resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Encounter/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n <li>\n A server <strong>(conformance expectation undefined)</strong> be capable of deleting a Encounter resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n <li>\n A server <strong>(conformance expectation undefined)</strong> be capable of a <code>read</code> interaction returning a Encounter resource using:\n <code class=\"highlighter-rouge\">GET [base]/Encounter/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n <h4 id=\"server_Observation\" class=\"no_toc\">Observation</h4>\n\n <p>Conformance Expectation:\t<strong/></p>\n\n \n\n \n\n \n \n\n\n <p>\n \n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n\n \n\n \n\n\n \n\n \n \n <li>\n A server <strong>(conformance expectation undefined)</strong> be capable of a <code>create</code> interaction creating a Observation resource using:\n <code class=\"highlighter-rouge\">POST [base]/Observation/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A server <strong>(conformance expectation undefined)</strong> be capable of updating a existing Observation resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Observation/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n <li>\n A server <strong>(conformance expectation undefined)</strong> be capable of deleting a Observation resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n <li>\n A server <strong>(conformance expectation undefined)</strong> be capable of a <code>read</code> interaction returning a Observation resource using:\n <code class=\"highlighter-rouge\">GET [base]/Observation/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n \n\n\n\n \n\n\n\n\n\n\n\n\n\n <!-- Messaging Capabilities -->\n \n\n <!-- Document Capabilities -->\n \n\n</div>"
},
"url" : "http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/cdex-capabilitystatement-inline-example",
"version" : "2.1.0-preview",
"status" : "active",
"date" : "2024-05-16",
"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" : "R4 example of a CapabilityStatement advertising support for CDex Task Update topic-based subscription",
"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",
"instantiates" : [
🔗 "http://hl7.org/fhir/uv/subscriptions-backport/CapabilityStatement/backport-subscription-server-r4|1.1.0"
],
"fhirVersion" : "4.0.1",
"format" : [
"json"
],
"implementationGuide" : [
🔗 "http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport"
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/capabilitystatement-subscriptiontopic-canonical",
"valueCanonical" : "http://hl7.org/fhir/us/davinci-cdex/SubscriptionTopic/cdex-task-update"
}
],
"type" : "Subscription",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription|1.1.0"
],
"interaction" : [
{
"code" : "read"
},
{
"code" : "create"
},
{
"code" : "update"
},
{
"code" : "delete"
}
],
"searchParam" : [
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/Subscription-url",
"type" : "uri"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Subscription-status",
"type" : "token"
}
],
"operation" : [
{
"name" : "status",
"definition" : "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status"
},
{
"name" : "events",
"definition" : "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events"
},
{
"name" : "get-ws-binding-token",
"definition" : "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-token"
}
]
},
{
"type" : "Patient",
"interaction" : [
{
"code" : "read"
},
{
"code" : "create"
},
{
"code" : "update"
},
{
"code" : "delete"
}
]
},
{
"type" : "Encounter",
"interaction" : [
{
"code" : "read"
},
{
"code" : "create"
},
{
"code" : "update"
},
{
"code" : "delete"
}
]
},
{
"type" : "Observation",
"interaction" : [
{
"code" : "read"
},
{
"code" : "create"
},
{
"code" : "update"
},
{
"code" : "delete"
}
]
}
]
}
]
}