Australian CVD Risk Calculator
Iteration3 - ci-build

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

- http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch|2.2.0

## FHIR RESTful Capabilities

### Mode: `client`

Aus CVD Risk-i application implements support for:

1. AU Core Patient resource profile
2. AU Core Practitioner resource profile
3. AU Core Encounter resource profile
4. AU Core Condition resource profile
5. AU Core Observation resource profiles
6. CVD Risk Sitting Blood Pressure Observation profile
7. CVD Risk Patient resource profile
8. CVD Risk Medication
9. CVD Risk Medication Request profile
10. CVD Risk Result Observation resource profile
11. RESTful behavior according to the FHIR specification
12. Support JSON source formats for all interactions

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 `transaction`interaction.
- Supports the `batch`interaction.

### 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 | http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient Additional supported profiles: CVD Risk Patient | y |  |  |  |  |  |  |
Practitioner | http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner | y |  |  |  |  |  |  |
Encounter | http://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter | y |  |  |  |  |  |  |
Condition | http://hl7.org.au/fhir/core/StructureDefinition/au-core-condition |  | y |  |  | patient, category |  |  |
Observation | 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 |  | y |  |  | patient, code |  |  |
Medication | https://www.cvdcheck.org.au/fhir/StructureDefinition/CVDRiskMedication | y |  |  |  |  |  |  |
MedicationRequest | https://www.cvdcheck.org.au/fhir/StructureDefinition/CVDRiskMedicationRequest |  | y |  |  | patient, status, _include | `MedicationRequest:medication` |  |
ValueSet | http://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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | patient | `reference` | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both.
SHALL | category | `token` | 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

Conformance | Parameters | Types
--- | --- | ---
| patient+category | `reference`+`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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | patient | `reference` | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both.
SHALL | code | `token` | 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

Conformance | Parameters | Types
--- | --- | ---
| patient+code | `reference`+`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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | patient | `reference` | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both.
SHALL | status | `token` | 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 | _include | `reference` | 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

Conformance | Parameters | Types
--- | --- | ---
| patient+status | `reference`+`token`
| patient+status+_include | `reference`+`token`+`reference`

#### Resource Conformance: supported ValueSet

Base System Profile
ValueSet
Profile Conformance
SHALL
Reference Policy

Interaction summary

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
SHALL | $expand |