XIG: CapabilityStatement/ExampleCapabilityStatement

FHIR IG Statistics: CapabilityStatement/ExampleCapabilityStatement

Package	tewhatuora.digitaltooling
Type	CapabilityStatement
Id	ExampleCapabilityStatement
FHIR Version	R4
Source	https://fhir-ig.digital.health.nz/hnz-digital-tooling/file:///home/runner/work/fhir-ig-builder/fhir-ig-builder/hnz-digital-tooling/output/CapabilityStatement-ExampleCapabilityStatement.html
URL	https://fhir-ig.digital.health.nz/hnz-digital-tooling/CapabilityStatement/ExampleCapabilityStatement
Version	1.1.0
Status	draft
Date	2024-04-18
Title	Example Capability Statement
Description	FHIR API for Patients
Kind	instance

Resources that use this resource

No resources found

Resources that this resource uses

StructureDefinition
example-patient	Example Patient Profile

Narrative

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

Generated Narrative: CapabilityStatement ExampleCapabilityStatement

Example Capability Statement

Implementation Guide Version: 1.1.0
FHIR Version: 4.0.1
Supported Formats: json
Supported Patch Formats:
Published on: 2024-04-18
Published by: null

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.

SHALL Support the Following Implementation Guides

https://fhir-ig.digital.health.nz/hnz-digital-tooling

FHIR RESTful Capabilities

Mode: `server`

Details the FHIR Server API for Patients. This API allows for the creation, retrieval and searching of Patient resources.

Security

Enable CORS: no

Security services supported: SMART-on-FHIR

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 Type	Profile	R	S	U	C	D	Searches	`_include`	`_revinclude`	Operations
Patient	http://hl7.org/fhir/StructureDefinition/Patient Additional supported profiles: Example Patient Profile	y	y	y	y	y	general-practitioner

Resource Conformance: supported Patient

Base System Profile
Patient

Profile Conformance
SHALL

Reference Policy

Supported Profiles

Example Patient Profile

Interaction summary

Supports read, search-type, create, update, delete.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	general-practitioner	`reference`	Patient's nominated general practitioner, not the organization that manages the record

Source

{
  "resourceType": "CapabilityStatement",
  "id": "ExampleCapabilityStatement",
  "meta": {
    "profile": [
      "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement"
    ]
  },
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "extension": [
        {
          "url": "licenseURL",
          "valueUri": "https://example.license.org"
        },
        {
          "url": "externalDocs",
          "valueUri": "https://docs.example.com/fhir"
        },
        {
          "url": "licenseName",
          "valueString": "GPLv3"
        },
        {
          "extension": [
            {
              "extension": [
                {
                  "url": "key",
                  "valueString": "Correlation-Id"
                },
                {
                  "url": "value",
                  "valueUri": "https://raw.githubusercontent.com/tewhatuora/schemas/main/fhir-definitions-oas/uuid-definition.json"
                },
                {
                  "url": "required",
                  "valueBoolean": true
                }
              ],
              "url": "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension"
            }
          ],
          "url": "globalHeaders"
        }
      ],
      "url": "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension"
    }
  ],
  "url": "https://fhir-ig.digital.health.nz/hnz-digital-tooling/CapabilityStatement/ExampleCapabilityStatement",
  "version": "1.1.0",
  "title": "Example Capability Statement",
  "status": "draft",
  "date": "2024-04-18",
  "contact": [
    {
      "name": "Example Contact Details",
      "telecom": [
        {
          "system": "url",
          "value": "https://example.com"
        }
      ]
    },
    {
      "name": "Email",
      "telecom": [
        {
          "system": "email",
          "value": "test@example.com"
        }
      ]
    }
  ],
  "description": "FHIR API for Patients",
  "kind": "instance",
  "implementation": {
    "description": "Patient FHIR API",
    "url": "https://example.digital.health.nz/fhir/R4"
  },
  "fhirVersion": "4.0.1",
  "format": [
    "json"
  ],
  "implementationGuide": [
    "https://fhir-ig.digital.health.nz/hnz-digital-tooling"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "Details the FHIR Server API for Patients. This API allows for the creation, retrieval and searching of Patient resources.",
      "security": {
        "extension": [
          {
            "extension": [
              {
                "url": "token",
                "valueUri": "https://auth.example.com/oauth2/token"
              },
              {
                "url": "authorize",
                "valueUri": "https://auth.example.com/oauth2/authorize"
              }
            ],
            "url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"
          },
          {
            "url": "http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities",
            "valueCode": "client-confidential-symmetric"
          },
          {
            "url": "http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities",
            "valueCode": "permission-user"
          },
          {
            "url": "http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities",
            "valueCode": "permission-patient"
          }
        ],
        "cors": false,
        "service": [
          {
            "coding": [
              {
                "code": "SMART-on-FHIR"
              }
            ]
          }
        ]
      },
      "resource": [
        {
          "type": "Patient",
          "profile": "http://hl7.org/fhir/StructureDefinition/Patient",
          "supportedProfile": [
            "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/example-patient"
          ],
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            },
            {
              "code": "create"
            },
            {
              "code": "update"
            },
            {
              "code": "delete"
            }
          ],
          "versioning": "versioned",
          "searchParam": [
            {
              "name": "general-practitioner",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-general-practitioner",
              "type": "reference",
              "documentation": "Patient's nominated general practitioner, not the organization that manages the record"
            }
          ]
        }
      ]
    }
  ]
}