FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package tewhatuora.fhir.nzps#current (32 ms)

Package tewhatuora.fhir.nzps
Type CapabilityStatement
Id Id
FHIR Version R4
Source https://standards.digital.health.nz/https://build.fhir.org/ig/tewhatuora/fhir-nzps/CapabilityStatement-HNZPatientSummaryCapabilityStatement.html
Url https://standards.digital.health.nz/CapabilityStatement/HNZPatientSummaryCapabilityStatement
Version 0.3.0
Status active
Date 2024-05-22
Name HNZPatientSummaryCapabilityStatement
Title HNZ Patient Summary CapabilityStatement
Experimental False
Realm nz
Authority national
Description HNZ Patient Summary API capability statement. This API supports the $summary operation to return an NZPS compliant FHIR document containing a summary of a patient based on infomration held by Health New Zealand collated from multiple systems of record and sources of truth systems.
Kind instance

Resources that use this resource

No resources found


Resources that this resource uses

OperationDefinition
https://standards.digital.health.nz/fhir/OperationDefinition/nzps-summary NZPS Summary


Narrative

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

HNZ Patient Summary CapabilityStatement

  • Implementation Guide Version: 0.3.0
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats:
  • Published on: 2024-05-22
  • Published by: Health NZ | Te Whatu Ora

Note to Implementers: FHIR Capabilities

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.

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Patient 

Resource Conformance: supported Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary

    Extended Operations
    ConformanceOperationDocumentation
    SHALL$summary

    Source

    {
      "resourceType" : "CapabilityStatement",
      "id" : "HNZPatientSummaryCapabilityStatement",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">HNZ Patient Summary CapabilityStatement </h2><ul><li>Implementation Guide Version: 0.3.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-05-22 </li><li>Published by: Health NZ | 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 &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>server</code></h3></div><div class=\"panel-body\"><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>�</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: supported </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 class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-NZPSSummaryOperation.html\">$summary</a></td><td><div/></td></tr></tbody></table></div></div></div></div></div></div>"
      },
      "url" : "https://standards.digital.health.nz/CapabilityStatement/HNZPatientSummaryCapabilityStatement",
      "version" : "0.3.0",
      "name" : "HNZPatientSummaryCapabilityStatement",
      "title" : "HNZ Patient Summary CapabilityStatement ",
      "status" : "active",
      "date" : "2024-05-22",
      "publisher" : "Health NZ | Te Whatu Ora",
      "contact" : [
        {
          "name" : "Health NZ | Te Whatu Ora",
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://github.com/tewhatuora"
            }
          ]
        }
      ],
      "description" : "HNZ Patient Summary API capability statement. This API supports the $summary operation to return an NZPS compliant FHIR document containing a summary of a patient based on infomration held by Health New Zealand collated from multiple systems of record and sources of truth systems.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "NZ",
              "display" : "New Zealand"
            }
          ]
        }
      ],
      "kind" : "instance",
      "implementation" : {
        "description" : "HNZ NZPS API",
        "url" : "https://tbc.com"
      },
      "fhirVersion" : "4.0.1",
      "format" : [
        "json"
      ],
      "rest" : [
        {
          "mode" : "server",
          "resource" : [
            {
              "type" : "Patient",
              "operation" : [
                {
                  "name" : "summary",
                  "definition" : "https://standards.digital.health.nz/fhir/OperationDefinition/nzps-summary"
                }
              ]
            }
          ]
        }
      ]
    }

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