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. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

CapabilityStatement: HTN-Mng-CardX Server Capability Statement

Official URL: http://hl7.org/fhir/uv/cardx-htn-mng/CapabilityStatement/CardXCapabilityStatementServer Version: 1.0.0-ballot
Draft as of 2023-12-05 Computable Name: CardXHTNServerCapabilityStatement

The capabilities that a CardX Hypertension Management server system should/shall support.

Raw OpenAPI-Swagger Definition file | Download

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:

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

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

  1. Support searches by Observation.patient. 1
Security
  1. See the General Security Considerations section for requirements and recommendations.
  2. 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 TypeProfileRSUCSearches_include_revincludeOperations
Patient 
ObservationSupported profiles:
  Self-measured Blood Pressure
  Average Self-measured Blood Pressure
  SMBP Associated Heart Rate		yyidentifier, 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
    ConformanceParameterTypeDocumentation
    SHALLcategorytoken
    SHOULDidentifierreference