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 Launch Server

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

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 expected capabilities for systems to launch and exchange data with the Aus CVD Risk Calculator application. It lists the server's conformance expectations for launching the application, supplying information for prepopulation, and recording the results as an output of using the application. These expectations include supported FHIR profiles, RESTful operations, and search parameters.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement AusCVDRiskCalculatorLaunchServer

Aus CVD Risk Calculator Launch Server

  • Implementation Guide Version: Iteration3
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support 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 Responder CapabilityStatement

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

Aus CVD Risk Calculator Launch Server SHALL:

  1. Support the AU Core Patient resource profile
  2. Support the AU Core Practitioner resource profile
  3. Support the CVD Risk Result Observation resource profile
  4. Implement the RESTful behavior according to the FHIR specification
  5. Support JSON source formats for all interactions

Aus CVD Risk Calculator Launch Server SHOULD:

  1. Support the AU Core Encounter resource profile
  2. Support the AU Core Condition resource profile
  3. Support the AU Core Observation resource profiles
  4. Support the CVD Risk Sitting Blood Pressure Observation profile
  5. Support the CVD Risk Patient profile
  6. Support the CVD Risk Medication
  7. Support the CVD Risk Medication Request profile
Security
Enable CORS: yes
Security services supported: SMART-on-FHIR

Aus CVD Risk Calculator Launch Server SHALL:

  1. Support CORS headers
  2. Support SMART on FHIR security services

Also see the AU Core Security and Privacy section for general considerations and recommendations.

Summary of System-wide Interactions
  • Supports the transactioninteraction described as follows:

    SHALL support the transaction interaction.

  • Supports the batchinteraction described as follows:

    SHALL support 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 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, clinical-status, category, _sort, patient+category, patient+clinical-status+category+_sort
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		yypatient, code, status, _count, _sort, patient+code, patient+code+status+_count+_sort
Medicationhttps://www.cvdcheck.org.au/fhir/StructureDefinition/CVDRiskMedicationy
MedicationRequesthttps://www.cvdcheck.org.au/fhir/StructureDefinition/CVDRiskMedicationRequestypatient, status, intent, _include, patient+status, patient+status+_include, patient+status+intent, patient+status+intent+_includeMedicationRequest:medication

Resource Conformance: SHALL Patient

Base System Profile
AU Core Patient
Profile Conformance
SHALL
Reference Policy

Supported Profiles

CVD Risk Patient

Interaction summary
  • SHALL support read.

Documentation

The server SHALL support the Patient resource, AU Core profile and the conformance expectations for the Patient resource.

The server SHOULD support the CVD Risk profile.

Resource Conformance: SHALL Practitioner

Base System Profile
AU Core Practitioner
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read.

Documentation

The server SHALL support the Practitioner resource, AU Core profile and the conformance expectations for the Practitioner resource.

Resource Conformance: SHOULD Encounter

Base System Profile
AU Core Encounter
Profile Conformance
SHOULD
Reference Policy

Interaction summary
  • SHOULD support read.

Documentation

The server SHOULD support the Encounter resource, AU Core profile and the conformance expectations for the Encounter resource.

Resource Conformance: SHOULD Condition

Base System Profile
AU Core Condition
Profile Conformance
SHOULD
Reference Policy

Interaction summary
  • SHOULD support search-type.

Documentation

The server SHOULD support 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.

MAYclinical-statustoken

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

The server SHALL support both.

The client SHALL support multipleOr.

The server SHALL support multipleOr.

MAYcategorytoken

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

The server SHALL support both.

MAY_sortstring

The client and server SHALL support search result sorting by date and MAY support other values.

Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+categoryreference+token
MAYpatient+clinical-status+category+_sortreference+token+token+string

Resource Conformance: SHALL Observation

Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • SHALL support create.
  • SHOULD support 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 server SHALL support the Observation resource, the CVD Risk Result profile and the conformance expectations for the Observation resource.

The server SHALL support create for the CVD Risk Result profile.

The server SHOULD support search-type for all other profiles listed.

Search Parameters
ConformanceParameterTypeDocumentation
MAYpatientreference

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

The server SHALL support both.

MAYcodetoken

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

The server SHALL support both.

MAYstatustoken

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.

MAY_countnumber

The client and server SHALL support search result limiting.

MAY_sortstring

The client and server SHALL support search result sorting by date and MAY support other values.

Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+codereference+token
MAYpatient+code+status+_count+_sortreference+token+token+number+string

Resource Conformance: SHOULD Medication

Base System Profile
CVD Risk Medication
Profile Conformance
SHOULD
Reference Policy

Interaction summary
  • SHOULD support read.

Documentation

If an external reference to a Medication resource is used in MedicationRequest, then the server SHOULD support the Medication resource, the CVD Risk profile and the conformance expectations for the Medication resource.

Resource Conformance: SHOULD MedicationRequest

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

Interaction summary
  • SHOULD support search-type.

Documentation

The server SHOULD support 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.

SHOULD_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.

MAYstatustoken

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.

MAYintenttoken

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.

Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+statusreference+token
SHOULDpatient+status+_includereference+token+reference
MAYpatient+status+intentreference+token+token
MAYpatient+status+intent+_includereference+token+token+reference