CardX Hypertension Management
1.0.0-ballot - STU1 ballot International flag

This page is part of the CardX Hypertension Management IG (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

: HTN-Mng-CardX Client Capability Statement - JSON Representation

Draft as of 2023-12-05

Raw json | Download


{
  "resourceType" : "CapabilityStatement",
  "id" : "CardXCapabilityStatementClient",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">HTN-Mng-CardX Client Capability Statement</h2><ul><li>Implementation Guide Version: 1.0.0-ballot</li><li>FHIR Version: 4.0.1</li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2023-12-05</li><li>Published by: HL7 International / Clinical Interoperability Council</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 &quot;SHALL NOT&quot;. 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>client</code></h3></div><div class=\"panel-body\"><div><p>A CardX Hypertension Management Patient Management Client <strong>SHALL</strong>:</p>\n<ol>\n<li>Support the Self-measured Blood Pressure Profile.</li>\n<li>Support the Average Self-measured Blood Pressure profile.</li>\n<li>Support json and xml source formats for all CardX interactions.\n1\nA CardX Hypertension Management Server <strong>should</strong>:</li>\n</ol>\n<p>1 Support the Self-measured Blood Pressure Associated Heart Rate profile.</p>\n<ol>\n<li>Support searches by Observation.patient.\n1</li>\n</ol>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><ol>\n<li>See the <a href=\"https://www.hl7.org/fhir/security.html#general\">General Security Considerations</a> section for requirements and recommendations.</li>\n<li>A server <strong>SHALL</strong> reject any unauthorized requests by returning an <code>HTTP 401</code> unauthorized response code.</li>\n</ol>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></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>\u00a0</td><td></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Observation1-2\">Observation</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-self-measured-bp.html\">Self-measured Blood Pressure</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-average-smbp.html\">Average Self-measured Blood Pressure</a><br/>\u00a0\u00a0<a href=\"StructureDefinition-smbp-associated-heart-rate.html\">SMBP Associated Heart Rate</a></td><td></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></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: SHOULD</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/></div></div><p/><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Observation1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL</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/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-self-measured-bp.html\">http://hl7.org/fhir/uv/cardx-htn-mng/StructureDefinition/self-measured-bp</a><br/><a href=\"StructureDefinition-average-smbp.html\">http://hl7.org/fhir/uv/cardx-htn-mng/StructureDefinition/average-smbp</a><br/><a href=\"StructureDefinition-smbp-associated-heart-rate.html\">http://hl7.org/fhir/uv/cardx-htn-mng/StructureDefinition/smbp-associated-heart-rate</a></p></div></div><p/></div></div></div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cic"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/cardx-htn-mng/CapabilityStatement/CardXCapabilityStatementClient",
  "version" : "1.0.0-ballot",
  "name" : "CardXClientCapabilityStatement",
  "title" : "HTN-Mng-CardX Client Capability Statement",
  "status" : "draft",
  "date" : "2023-12-05",
  "publisher" : "HL7 International / Clinical Interoperability Council",
  "contact" : [
    {
      "name" : "HL7 International / Clinical Interoperability Council",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cic"
        },
        {
          "system" : "email",
          "value" : "ciclist@lists.hl7.org"
        }
      ]
    }
  ],
  "description" : "The capabilities that a CardX Hypertension Management client should/shall support.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "xml",
    "json"
  ],
  "rest" : [
    {
      "mode" : "client",
      "documentation" : "A CardX Hypertension Management Patient Management Client **SHALL**:\n\n1. Support the Self-measured Blood Pressure Profile. \n1. Support the Average Self-measured Blood Pressure profile.\n1. Support json and xml source formats for all CardX interactions. \n1\n A CardX Hypertension Management Server **should**:\n\n1 Support the Self-measured Blood Pressure Associated Heart Rate profile.\n1. Support searches by Observation.patient.\n1\n",
      "security" : {
        "description" : "1. See the [General Security Considerations](https://www.hl7.org/fhir/security.html#general) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."
      },
      "resource" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            }
          ],
          "type" : "Patient"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "Observation",
          "supportedProfile" : [
            🔗 "http://hl7.org/fhir/uv/cardx-htn-mng/StructureDefinition/self-measured-bp"🔗 ,
            "http://hl7.org/fhir/uv/cardx-htn-mng/StructureDefinition/average-smbp"🔗 ,
            "http://hl7.org/fhir/uv/cardx-htn-mng/StructureDefinition/smbp-associated-heart-rate"
          ],
          "_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" : "SHOULD"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}