Hero

Australian CVD Risk Calculator
Iteration3 - ci-build Australia flag

Australian CVD Risk Calculator - Local Development build (vIteration3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: Aus CVD Risk Calculator Application

Official URL: https://www.cvdcheck.org.au/fhir/CapabilityStatement/AusCVDRiskCalculatorApplication Version: Iteration3
Draft as of 2025-01-10 Computable Name: AusCVDRiskCalculatorApplication

Copyright/Legal: Copyright © 2024+ National Heart Foundation of Australia - All rights reserved. This content is not available under an open source licence.

This CapabilityStatement describes the capabilities of the Aus CVD Risk-i application. These capabilities include supported FHIR profiles, RESTful operations, and search parameters.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement AusCVDRiskCalculatorApplication

Aus CVD Risk Calculator Application

  • Implementation Guide Version: Iteration3
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats:
  • Published on: 2025-01-10
  • Published by: National Heart Foundation of Australia

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.

This CapabilityStatement instantiates the CapabilityStatement AU Core Requester CapabilityStatement

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: client

Security
Enable CORS: yes
Security services supported: SMART-on-FHIR

Aus CVD Risk-i application supports:

  1. CORS headers
  2. SMART on FHIR security services
Summary of System-wide Interactions
  • Supports the transactioninteraction.
  • Supports the batchinteraction.

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
Patienthttp://hl7.org.au/fhir/core/StructureDefinition/au-core-patient
Additional supported profiles:
  CVD Risk Patient		y
Practitionerhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionery
Encounterhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-encountery
Conditionhttp://hl7.org.au/fhir/core/StructureDefinition/au-core-conditionypatient, category
ObservationSupported Profiles
  CVD Risk Result
  CVD Risk Sitting Blood Pressure
  AU Core Smoking Status
  AU Core Pathology Result Observation
  AU Core Body Height
  AU Core Body Weight		ypatient, code
Medicationhttps://www.cvdcheck.org.au/fhir/StructureDefinition/CVDRiskMedicationy
MedicationRequesthttps://www.cvdcheck.org.au/fhir/StructureDefinition/CVDRiskMedicationRequestypatient, status, _includeMedicationRequest:medication
ValueSethttp://hl7.org/fhir/StructureDefinition/ValueSet$expand

Resource Conformance: supported Patient

Base System Profile
AU Core Patient
Profile Conformance
SHALL
Reference Policy

Supported Profiles

CVD Risk Patient

Interaction summary
  • Supports read.

Documentation

The application supports the Patient resource, AU Core profile, CVD Risk profile and the conformance expectations for the Patient resource.

Resource Conformance: supported Practitioner

Base System Profile
AU Core Practitioner
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Documentation

The application supports the Practitioner resource, AU Core profile and the conformance expectations for the Practitioner resource.

Resource Conformance: supported Encounter

Base System Profile
AU Core Encounter
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Documentation

The application supports the Encounter resource, AU Core profile and the conformance expectations for the Encounter resource.

Resource Conformance: supported Condition

Base System Profile
AU Core Condition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type.

Documentation

The application supports the Condition resource, the AU Core profile and the conformance expectations for the Condition resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.

SHALLcategorytoken

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.

Combined Search Parameters
ConformanceParametersTypes
 patient+categoryreference+token

Resource Conformance: supported Observation

Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • Supports search-type.

Supported Profiles

CVD Risk Result
CVD Risk Sitting Blood Pressure
AU Core Smoking Status
AU Core Pathology Result Observation
AU Core Body Height
AU Core Body Weight

Documentation

The application supports the Observation resource, the CVD Risk Result profile, the CVD Risk Sitting Blood Pressure profile, AU Core profiles listed and the conformance expectations for the Observation resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.

SHALLcodetoken

The client SHALL provide at least a code value and MAY provide both the code and system values.

The server SHALL support both.

Combined Search Parameters
ConformanceParametersTypes
 patient+codereference+token

Resource Conformance: supported Medication

Base System Profile
CVD Risk Medication
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Documentation

The client SHOULD support the Medication resource, the CVD Risk profile and the conformance expectations for the Medication resource.

Resource Conformance: supported MedicationRequest

Base System Profile
CVD Risk Medication Request
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type.

Documentation

The application supports the MedicationRequest resource, the CVD Risk profile and the conformance expectations for the MedicationRequest resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.

SHALLstatustoken

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.

The client SHALL support multipleOr.

The server SHALL support multipleOr.

SHALL_includereference

If a medication in a MedicationRequest resource is represented as an external Medication resource reference, the server SHOULD support the _include parameter for searching this element (MedicationRequest:medication).

The client SHALL support this method.

Combined Search Parameters
ConformanceParametersTypes
 patient+statusreference+token
 patient+status+_includereference+token+reference

Resource Conformance: supported ValueSet

Base System Profile
ValueSet
Profile Conformance
SHALL
Reference Policy

Interaction summary

    Extended Operations
    ConformanceOperationDocumentation
    SHALL$expand