Resource CapabilityStatement/FHIR Server from package hl7.org.nz.fhir.ig.mdr#current (94 ms)

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "ConsumerCapabliityStatement",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement ConsumerCapabliityStatement</b></p><a name=\"ConsumerCapabliityStatement\"> </a><a name=\"hcConsumerCapabliityStatement\"> </a><a name=\"ConsumerCapabliityStatement-en-US\"> </a><h2 id=\"title\">Medicines Data Repository FHIR Server</h2><ul><li>Implementation Guide Version: 0.1.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2023-02-24 01:15:23+0000 </li><li>Published by: Te Whatu Ora </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>Security</em></div><div class=\"row\"><div class=\"col-lg-6\">Enable CORS: no</div><div class=\"col-lg-6\">Security services supported: <code>OAuth</code></div></div><blockquote><div><p>Supports OAuth 2.0 - Client Credential flow. [OAuth token endpoint] (https://login.microsoftonline.com/7a71250a-e506-4080-8e6a-ae1e8a771e22/oauth2/v2.0/token)</p>\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=\"#MedicationRequest1-1\">MedicationRequest</a></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html\">http://hl7.org/fhir/StructureDefinition/MedicationRequest</a></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_lastUpdated, _security, status, authoredon, patient</td><td/><td><code>MedicationDispense:prescription</code></td><td/></tr><tr><td><a href=\"#MedicationDispense1-2\">MedicationDispense</a></td><td><a href=\"http://hl7.org/fhir/R4/medicationdispense.html\">http://hl7.org/fhir/StructureDefinition/MedicationDispense</a></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_lastUpdated, _security, patient, whenprepared, whenhandedover, status</td><td><code>MedicationDispense:prescription</code>, <code>MedicationDispense:medication</code></td><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"MedicationRequest1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>MedicationRequest</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"http://hl7.org/fhir/R4/medicationrequest.html\">MedicationRequest</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code>, <code>local</code></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></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><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>When the resource version last changed (use format yyyy-mm-ddThh:mm:ssZ)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_security</a></td><td><code>token</code></td><td><div><p>Security Labels applied to this resource</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">status</a></td><td><code>token</code></td><td><div><p>Status of the prescription</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">authoredon</a></td><td><code>date</code></td><td><div><p>Return prescriptions written on this date (use format yyyy-mm-ddThh:mm:ssZ)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Returns prescriptions for a specific patient (NHI)</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"MedicationDispense1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>MedicationDispense</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"http://hl7.org/fhir/R4/medicationdispense.html\">MedicationDispense</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code>, <code>local</code></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></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><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>When the resource version last changed (use format yyyy-mm-ddThh:mm:ssZ)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_security</a></td><td><code>token</code></td><td><div><p>Security Labels applied to this resource</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationdispense.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The identity of a patient to list dispenses  for (NHI)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationdispense.html#search\">whenprepared</a></td><td><code>date</code></td><td><div><p>Returns dispenses prepared on this date (use format yyyy-mm-ddThh:mm:ssZ)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationdispense.html#search\">whenhandedover</a></td><td><code>date</code></td><td><div><p>Returns dispenses handed over on this date (use format yyyy-mm-ddThh:mm:ssZ)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationdispense.html#search\">status</a></td><td><code>token</code></td><td><div><p>Returns dispenses with a specified dispense status</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div></div>"
  },
  "url" : "https://preprod-apibroker.whanautahi.com/mcv/fhir/metadata",
  "version" : "0.1.0",
  "name" : "NZ_MDR",
  "title" : "Medicines Data Repository FHIR Server",
  "status" : "draft",
  "experimental" : true,
  "date" : "2023-02-24T01:15:23.3688326Z",
  "publisher" : "Te Whatu Ora",
  "contact" : [
    {
      "name" : "Te Whatu Ora",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://tewhatuora.govt.nz"
        },
        {
          "system" : "email",
          "value" : "mailto:integration@health.govt.nz"
        }
      ]
    }
  ],
  "description" : "MDR Consumer View Capability Statement",
  "kind" : "capability",
  "software" : {
    "name" : "Medicines Consumer View FHIR API",
    "version" : "1.0.0.0"
  },
  "fhirVersion" : "4.0.1",
  "format" : [
    "application/fhir+json"
  ],
  "rest" : [
    {
      "mode" : "server",
      "security" : {
        "service" : [
          {
            "coding" : [
              {
                "system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code" : "OAuth"
              }
            ]
          }
        ],
        "description" : "Supports OAuth 2.0 - Client Credential flow. [OAuth token endpoint] (https://login.microsoftonline.com/7a71250a-e506-4080-8e6a-ae1e8a771e22/oauth2/v2.0/token)"
      },
      "resource" : [
        {
          "type" : "MedicationRequest",
          "profile" : "http://hl7.org/fhir/StructureDefinition/MedicationRequest",
          "interaction" : [
            {
              "code" : "read"
            }
          ],
          "versioning" : "no-version",
          "readHistory" : false,
          "updateCreate" : false,
          "conditionalCreate" : false,
          "conditionalRead" : "not-supported",
          "conditionalUpdate" : false,
          "conditionalDelete" : "not-supported",
          "referencePolicy" : [
            "literal",
            "local"
          ],
          "searchRevInclude" : [
            "MedicationDispense:prescription"
          ],
          "searchParam" : [
            {
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date",
              "documentation" : "When the resource version last changed (use format yyyy-mm-ddThh:mm:ssZ)"
            },
            {
              "name" : "_security",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-security",
              "type" : "token",
              "documentation" : "Security Labels applied to this resource"
            },
            {
              "name" : "status",
              "definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
              "type" : "token",
              "documentation" : "Status of the prescription"
            },
            {
              "name" : "authoredon",
              "definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon",
              "type" : "date",
              "documentation" : "Return prescriptions written on this date (use format yyyy-mm-ddThh:mm:ssZ)"
            },
            {
              "name" : "patient",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type" : "reference",
              "documentation" : "Returns prescriptions for a specific patient (NHI)"
            }
          ]
        },
        {
          "type" : "MedicationDispense",
          "profile" : "http://hl7.org/fhir/StructureDefinition/MedicationDispense",
          "interaction" : [
            {
              "code" : "read"
            }
          ],
          "versioning" : "no-version",
          "readHistory" : false,
          "updateCreate" : false,
          "conditionalCreate" : false,
          "conditionalRead" : "not-supported",
          "conditionalUpdate" : false,
          "conditionalDelete" : "not-supported",
          "referencePolicy" : [
            "literal",
            "local"
          ],
          "searchInclude" : [
            "MedicationDispense:prescription",
            "MedicationDispense:medication"
          ],
          "searchParam" : [
            {
              "name" : "_lastUpdated",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type" : "date",
              "documentation" : "When the resource version last changed (use format yyyy-mm-ddThh:mm:ssZ)"
            },
            {
              "name" : "_security",
              "definition" : "http://hl7.org/fhir/SearchParameter/Resource-security",
              "type" : "token",
              "documentation" : "Security Labels applied to this resource"
            },
            {
              "name" : "patient",
              "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type" : "reference",
              "documentation" : "The identity of a patient to list dispenses  for (NHI)"
            },
            {
              "name" : "whenprepared",
              "definition" : "http://hl7.org/fhir/SearchParameter/MedicationDispense-whenprepared",
              "type" : "date",
              "documentation" : "Returns dispenses prepared on this date (use format yyyy-mm-ddThh:mm:ssZ)"
            },
            {
              "name" : "whenhandedover",
              "definition" : "http://hl7.org/fhir/SearchParameter/MedicationDispense-whenhandedover",
              "type" : "date",
              "documentation" : "Returns dispenses handed over on this date (use format yyyy-mm-ddThh:mm:ssZ)"
            },
            {
              "name" : "status",
              "definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
              "type" : "token",
              "documentation" : "Returns dispenses with a specified dispense status"
            }
          ]
        }
      ],
      "searchParam" : [
        {
          "name" : "_count",
          "type" : "number",
          "documentation" : "How many resources to return"
        },
        {
          "name" : "_sort",
          "type" : "token",
          "documentation" : "How to sort the resources when returning"
        },
        {
          "name" : "_total",
          "type" : "number",
          "documentation" : "Include number of resources that match the search parameters; Only Partial support available (_total=none and _total=accurate)"
        },
        {
          "name" : "_elements",
          "type" : "string",
          "documentation" : "What kind of information to return"
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.