ACT-NOW Implementation Guide
0.5.0 - ci-build

ACT-NOW Implementation Guide, published by Te aho o te kahu - Cancer Control Agency. This guide is not an authorized publication; it is the continuous build for version 0.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/actnow/ and changes regularly. See the Directory of published versions

## : CapabilityStatement representing the server requirements for a FHIR server - JSON Representation

Draft as of 2022-10-03

Raw json | Download

    {
      "resourceType" : "CapabilityStatement",
      "id" : "AnCapabilityStatement",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement AnCapabilityStatement</b></p><a name=\"AnCapabilityStatement\"> </a><a name=\"hcAnCapabilityStatement\"> </a><h2 id=\"title\">CapabilityStatement representing the server requirements for a FHIR server</h2><ul><li>Implementation Guide Version: 0.5.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Published on: 2022-10-03 </li><li>Published by: Te aho o te kahu - Cancer Control Agency </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 class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>transaction</code>interaction.</li></ul></div></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=\"#Patient1-1\">Patient</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-an-patient.html\">ACT-NOW patient</a></td><td class=\"text-center\"/><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>identifier, name, gender</td><td/><td/><td/></tr><tr><td><a href=\"#CarePlan1-2\">CarePlan</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-an-careplan-regimen.html\">Regimen Careplan</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-an-careplan-cycle.html\">Cycle Careplan</a></td><td class=\"text-center\"/><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>identifier</td><td/><td/><td/></tr><tr><td><a href=\"#Observation1-3\">Observation</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-an-cT.html\">Clinical T-score</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-an-cN.html\">Clinical N-score</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-an-cM.html\">Clinical M-score</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-an-cGroup.html\">Clinical TNM group score</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-an-pT.html\">Pathological T-score</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-an-pN.html\">Pathological N-score</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-an-pM.html\">Pathological M-score</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-an-pGroup.html\">Pathological TNM group score</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-an-bsa.html\">Body Surface Area</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-an-creat-clear.html\">Creatinine Clearance</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-an-height.html\">Height</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-an-weight.html\">Weight</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-an-histology.html\">Histology</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-an-ecog.html\">ECOG score</a></td><td class=\"text-center\"/><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>identifier</td><td/><td/><td/></tr><tr><td><a href=\"#MedicationAdministration1-4\">MedicationAdministration</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-an-medication-administration.html\">ACT-NOW medication administration</a></td><td class=\"text-center\"/><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>identifier</td><td/><td/><td/></tr><tr><td><a href=\"#MedicationRequest1-5\">MedicationRequest</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-an-medication-request.html\">ACT-NOW medication request</a></td><td class=\"text-center\"/><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>identifier</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>Patient</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/patient.html\">Patient</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>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-an-patient.html\">ACT-NOW patient</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>identifier</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>gender</td><td><code>token</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=\"CarePlan1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>CarePlan</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/careplan.html\">CarePlan</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>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-an-careplan-regimen.html\">Regimen Careplan</a><br/><a href=\"StructureDefinition-an-careplan-cycle.html\">Cycle Careplan</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>identifier</td><td><code>token</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=\"Observation1-3\" 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>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-an-cT.html\">Clinical T-score</a><br/><a href=\"StructureDefinition-an-cN.html\">Clinical N-score</a><br/><a href=\"StructureDefinition-an-cM.html\">Clinical M-score</a><br/><a href=\"StructureDefinition-an-cGroup.html\">Clinical TNM group score</a><br/><a href=\"StructureDefinition-an-pT.html\">Pathological T-score</a><br/><a href=\"StructureDefinition-an-pN.html\">Pathological N-score</a><br/><a href=\"StructureDefinition-an-pM.html\">Pathological M-score</a><br/><a href=\"StructureDefinition-an-pGroup.html\">Pathological TNM group score</a><br/><a href=\"StructureDefinition-an-bsa.html\">Body Surface Area</a><br/><a href=\"StructureDefinition-an-creat-clear.html\">Creatinine Clearance</a><br/><a href=\"StructureDefinition-an-height.html\">Height</a><br/><a href=\"StructureDefinition-an-weight.html\">Weight</a><br/><a href=\"StructureDefinition-an-histology.html\">Histology</a><br/><a href=\"StructureDefinition-an-ecog.html\">ECOG score</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>identifier</td><td><code>token</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=\"MedicationAdministration1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>MedicationAdministration</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/medicationadministration.html\">MedicationAdministration</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>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-an-medication-administration.html\">ACT-NOW medication administration</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>identifier</td><td><code>token</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=\"MedicationRequest1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>MedicationRequest</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/medicationrequest.html\">MedicationRequest</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>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-an-medication-request.html\">ACT-NOW medication request</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>identifier</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
      },
      "url" : "http://canshare.co.nz/fhir/CapabilityStatement/AnCapabilityStatement",
      "version" : "0.5.0",
      "name" : "CanShareCapabilityStatement",
      "title" : "CapabilityStatement representing the server requirements for a FHIR server",
      "status" : "draft",
      "date" : "2022-10-03",
      "publisher" : "Te aho o te kahu - Cancer Control Agency",
      "contact" : [
        {
          "name" : "Te aho o te kahu - Cancer Control Agency",
          "telecom" : [
            {
              "system" : "email",
              "value" : "mailto:david.hay25@gmail.com"
            }
          ]
        }
      ],
      "description" : "Describes the server requirements for ACT-NOW",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "NZ",
              "display" : "New Zealand"
            }
          ]
        }
      ],
      "kind" : "requirements",
      "fhirVersion" : "4.0.1",
      "format" : [
        "json"
      ],
      "rest" : [
        {
          "mode" : "server",
          "resource" : [
            {
              "type" : "Patient",
              "supportedProfile" : [
                🔗 "http://canshare.co.nz/fhir/StructureDefinition/an-patient"
              ],
              "interaction" : [
                {
                  "code" : "search-type"
                }
              ],
              "conditionalCreate" : true,
              "conditionalUpdate" : true,
              "searchParam" : [
                {
                  "name" : "identifier",
                  "type" : "token"
                },
                {
                  "name" : "name",
                  "type" : "string"
                },
                {
                  "name" : "gender",
                  "type" : "token"
                }
              ]
            },
            {
              "type" : "CarePlan",
              "supportedProfile" : [
                🔗 "http://canshare.co.nz/fhir/StructureDefinition/an-careplan-regimen"🔗 ,
                "http://canshare.co.nz/fhir/StructureDefinition/an-careplan-cycle"
              ],
              "interaction" : [
                {
                  "code" : "search-type"
                }
              ],
              "conditionalCreate" : true,
              "conditionalUpdate" : true,
              "searchParam" : [
                {
                  "name" : "identifier",
                  "type" : "token"
                }
              ]
            },
            {
              "type" : "Observation",
              "supportedProfile" : [
                🔗 "http://canshare.co.nz/fhir/StructureDefinition/an-cT"🔗 ,
                "http://canshare.co.nz/fhir/StructureDefinition/an-cN"🔗 ,
                "http://canshare.co.nz/fhir/StructureDefinition/an-cM"🔗 ,
                "http://canshare.co.nz/fhir/StructureDefinition/an-cGroup"🔗 ,
                "http://canshare.co.nz/fhir/StructureDefinition/an-pT"🔗 ,
                "http://canshare.co.nz/fhir/StructureDefinition/an-pN"🔗 ,
                "http://canshare.co.nz/fhir/StructureDefinition/an-pM"🔗 ,
                "http://canshare.co.nz/fhir/StructureDefinition/an-pGroup"🔗 ,
                "http://canshare.co.nz/fhir/StructureDefinition/an-bsa"🔗 ,
                "http://canshare.co.nz/fhir/StructureDefinition/an-creat-clear"🔗 ,
                "http://canshare.co.nz/fhir/StructureDefinition/an-height"🔗 ,
                "http://canshare.co.nz/fhir/StructureDefinition/an-weight"🔗 ,
                "http://canshare.co.nz/fhir/StructureDefinition/an-histology"🔗 ,
                "http://canshare.co.nz/fhir/StructureDefinition/an-ecog"
              ],
              "interaction" : [
                {
                  "code" : "search-type"
                }
              ],
              "conditionalCreate" : true,
              "conditionalUpdate" : true,
              "searchParam" : [
                {
                  "name" : "identifier",
                  "type" : "token"
                }
              ]
            },
            {
              "type" : "MedicationAdministration",
              "supportedProfile" : [
                🔗 "http://canshare.co.nz/fhir/StructureDefinition/an-medication-administration"
              ],
              "interaction" : [
                {
                  "code" : "search-type"
                }
              ],
              "conditionalCreate" : true,
              "conditionalUpdate" : true,
              "searchParam" : [
                {
                  "name" : "identifier",
                  "type" : "token"
                }
              ]
            },
            {
              "type" : "MedicationRequest",
              "supportedProfile" : [
                🔗 "http://canshare.co.nz/fhir/StructureDefinition/an-medication-request"
              ],
              "interaction" : [
                {
                  "code" : "search-type"
                }
              ],
              "conditionalCreate" : true,
              "conditionalUpdate" : true,
              "searchParam" : [
                {
                  "name" : "identifier",
                  "type" : "token"
                }
              ]
            }
          ],
          "interaction" : [
            {
              "code" : "transaction"
            }
          ]
        }
      ]
    }