FHIRsmith: CapabilityStatement/CapabilityStatement-CardXCapabilityStatementServer.json

FHIR IG analytics

Package	hl7.fhir.uv.cardx-htn-mng.r4
Resource Type	CapabilityStatement
Id	CapabilityStatement-CardXCapabilityStatementServer.json
FHIR Version	R4

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

HTN-Mng-CardX Server Capability Statement

Implementation Guide Version: 1.0.0-ballot
FHIR Version: 4.0.1
Supported Formats: xml, json
Supported Patch Formats:
Published on: 2023-12-05
Published by: HL7 International / Clinical Interoperability Council

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`

A CardX Hypertension Management Patient Management Server SHALL:

Support the Self-measured Blood Pressure Profile.
Support the Average Self-measured Blood Pressure profile.
Support json and xml source formats for all CardX interactions.
Support searches by Observation.category. 1 A CardX Hypertension Management Server should:

1 Support the Self-measured Blood Pressure Associated Heart Rate profile.

Support searches by Observation.patient. 1

Security

See the General Security Considerations section for requirements and recommendations.

A server SHALL reject any unauthorized requests by returning an HTTP 401 unauthorized response code.

Summary of System-wide Interactions

Supports the history-system interaction described as follows:
A CardX Hypertension Management Server SHALL:
1. Support read operations.
2. Support search-type operations. 1

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	Searches	`_include`	`_revinclude`	Operations
Patient
Observation	Supported profiles: Self-measured Blood Pressure Average Self-measured Blood Pressure SMBP Associated Heart Rate	y	y			identifier, category

Resource Conformance: SHOULDPatient

Core FHIR Resource
Patient

Reference Policy

Interaction summary

Resource Conformance: SHALLObservation

Core FHIR Resource
Observation

Reference Policy

Interaction summary

SHALL support read, search-type.

Supported Profiles

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

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	category	`token`
SHOULD	identifier	`reference`

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "CardXCapabilityStatementServer",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cic"
    }
  ],
  "url": "http://hl7.org/fhir/uv/cardx-htn-mng/CapabilityStatement/CardXCapabilityStatementServer",
  "version": "1.0.0-ballot",
  "name": "CardXHTNServerCapabilityStatement",
  "title": "HTN-Mng-CardX Server 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 server system 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": "server",
      "documentation": "A CardX Hypertension Management Patient Management Server **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. Support searches by Observation.category. \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"
                }
              ]
            }
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/Observation-category",
              "type": "token"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "history-system",
          "documentation": "A CardX Hypertension Management Server **SHALL**:\n\n1. Support read operations. \n1. Support search-type operations. \n1\n"
        }
      ]
    }
  ]
}