FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/CardXCapabilityStatementClient

Packagehl7.fhir.uv.cardx-htn-mng
TypeCapabilityStatement
IdCardXCapabilityStatementClient
FHIR VersionR4
Sourcehttp://hl7.org/fhir/uv/cardx-htn-mng/https://build.fhir.org/ig/HL7/CardX-HTN-MNG/CapabilityStatement-CardXCapabilityStatementClient.html
URLhttp://hl7.org/fhir/uv/cardx-htn-mng/CapabilityStatement/CardXCapabilityStatementClient
Version1.0.0
Statusdraft
Date2023-12-05
NameCardXClientCapabilityStatement
TitleHTN-Mng-CardX Client Capability Statement
Realmuv
Authorityhl7
DescriptionThe capabilities that a CardX Hypertension Management client should/shall support.
Kindrequirements

Resources that use this resource

No resources found

Resources that this resource uses

StructureDefinition
average-smbpAverage Self-measured Blood Pressure
self-measured-bpSelf-measured Blood Pressure
smbp-associated-heart-rateSMBP Associated Heart Rate

Narrative

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

Generated Narrative: CapabilityStatement CardXCapabilityStatementClient

HTN-Mng-CardX Client Capability Statement

  • Implementation Guide Version: 1.0.0
  • 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: client

A CardX Hypertension Management Client 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.

A CardX Hypertension Management Client SHOULD:

  1. Support the Self-measured Blood Pressure Associated Heart Rate profile.
  2. Support searches by Observation.patient.
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

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		yyyidentifier, category

Resource Conformance: SHOULD Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary

    Resource Conformance: SHALL Observation

    Core FHIR Resource
    Observation
    Reference Policy
    Interaction summary
    • SHALL support read, create, search-type.

    Supported Profiles

    Self-measured Blood Pressure
    Average Self-measured Blood Pressure
    SMBP Associated Heart Rate

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALLcategorytoken
    SHOULDidentifierreference
     

    Source

    {
  "resourceType": "CapabilityStatement",
  "id": "CardXCapabilityStatementClient",
  "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/CardXCapabilityStatementClient",
  "version": "1.0.0",
  "name": "CardXClientCapabilityStatement",
  "title": "HTN-Mng-CardX Client 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 client 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": "client",
      "documentation": "A CardX Hypertension Management Client **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. \n\n\n A CardX Hypertension Management Client **SHOULD**:\n\n1. Support the Self-measured Blood Pressure Associated Heart Rate profile.\n1. Support searches by Observation.patient.\n\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": "create"
            },
            {
              "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"
            }
          ]
        }
      ]
    }
  ]
}