Dermatology Image Annotation FHIR Implementation Guide
0.1.0 - ci-build
Dermatology Image Annotation FHIR Implementation Guide
0.1.0 - ci-build
Dermatology Image Annotation FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2025-01-01 |
{
"resourceType" : "CapabilityStatement",
"id" : "annotatemd-server",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement annotatemd-server</b></p><a name=\"annotatemd-server\"> </a><a name=\"hcannotatemd-server\"> </a><h2 id=\"title\">Annotate MD Server Capability Statement</h2><ul><li>Implementation Guide Version: 0.1.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code>, <code>xml</code></li><li>Published on: 2025-01-01 </li><li>Published by: Annotate MD </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"/></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Observation1-1\">Observation</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-dermatology-image-annotation.html\">Dermatology Image Annotation</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-ai-prediction.html\">AI Prediction</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-annotation-series.html\">Annotation Series</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\">y</td><td>patient, category, code, date, status, method, derived-from</td><td/><td/><td/></tr><tr><td><a href=\"#Provenance1-2\">Provenance</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\">y</td><td/><td/><td/><td/></tr><tr><td><a href=\"#Device1-3\">Device</a></td><td>\u00a0</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Observation1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>Observation</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>, <code>create</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-dermatology-image-annotation.html\">Dermatology Image Annotation</a><br/><a href=\"StructureDefinition-ai-prediction.html\">AI Prediction</a><br/><a href=\"StructureDefinition-annotation-series.html\">Annotation Series</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>category</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>code</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-observation-method.html\">method</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-observation-derived-from.html\">derived-from</a></td><td><code>reference</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Provenance1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>Provenance</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/provenance.html\">Provenance</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>, <code>create</code>.</li></ul></div></div><p/><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Device1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>Device</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/device.html\">Device</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><p/></div></div></div></div>"
},
"url" : "https://annotatemd.com/fhir/ig/CapabilityStatement/annotatemd-server",
"version" : "0.1.0",
"name" : "AnnotateMDServer",
"title" : "Annotate MD Server Capability Statement",
"status" : "draft",
"date" : "2025-01-01",
"publisher" : "Annotate MD",
"contact" : [
{
"name" : "Annotate MD",
"telecom" : [
{
"system" : "url",
"value" : "https://annotatemd.com"
},
{
"system" : "email",
"value" : "fhir@annotatemd.com"
}
]
}
],
"description" : "Defines the expected capabilities of a server implementing the Dermatology Image Annotation IG.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"type" : "Observation",
"supportedProfile" : [
🔗 "https://annotatemd.com/fhir/ig/StructureDefinition/dermatology-image-annotation"🔗 ,
"https://annotatemd.com/fhir/ig/StructureDefinition/ai-prediction"🔗 ,
"https://annotatemd.com/fhir/ig/StructureDefinition/annotation-series"
],
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
},
{
"code" : "create"
}
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference"
},
{
"name" : "category",
"type" : "token"
},
{
"name" : "code",
"type" : "token"
},
{
"name" : "date",
"type" : "date"
},
{
"name" : "status",
"type" : "token"
},
{
"name" : "method",
"definition" : "https://annotatemd.com/fhir/ig/SearchParameter/observation-method",
"type" : "token"
},
{
"name" : "derived-from",
"definition" : "https://annotatemd.com/fhir/ig/SearchParameter/observation-derived-from",
"type" : "reference"
}
]
},
{
"type" : "Provenance",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
},
{
"code" : "create"
}
]
},
{
"type" : "Device",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
]
}
]
}
]
}