Smart Health Checks
0.3.0 - ci-build Australia flag

Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/smart-forms-ig/ and changes regularly. See the Directory of published versions

Artefacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Requirements: Actor Definitions

The following artifacts define the types of individuals and/or systems that will interact as part of the use cases covered by this implementation guide.

SHC App

The SHC App is a system that a SHC Host can launch allowing a user to fill out a health check form, prepopulated with patient health information retrieved from the SHC Host FHIR Server, and writeback data collected in the form.

SHC Host

The SHC Host is a system that allows a user to launch the SHC App within an embedded or externally launched web browser to fill out a health check form.

SHC Host Authorization Server

The SHC Host Authorization Server allows the SHC App to request authorisation from the PMS user to access patient health information to prepopulate and write back health checks data using the PMS FHIR Server.

SHC Host FHIR Server

The SHC Host FHIR Server allows the SHC App to retrieve patient health information and writeback collected health check data.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

SHC App

This CapabilityStatement describes the capabilities of the SHC App. These capabilities include supported FHIR profiles, RESTful operations, and search parameters. It covers supported tasks such as SMART App launch context, prepopulation, write-back of extracted resources and completion of forms.

SHC Host FHIR Server

This CapabilityStatement describes the expected capabilities for systems to launch and exchange data with the SHC App to support the Aboriginal and Torres Strait Islander Health Check. It lists the server's conformance expectations for the resource types required as a launch context, resource types required to support prepopulation of the form, resource types required to support writing back to the patient record, and QuestionnaireResponse requirements for managing form responses. These expectations include supported FHIR profiles, RESTful operations, and search parameters.

Structures: Questionnaires

These define forms used by systems conforming to this implementation guide to capture or expose data to end users.

Aboriginal and Torres Strait Islander Health Check

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

AU Core Head Circumference

This profile sets minimum expectations for an Observation resource to record, search, and fetch head circumference observations with standard coding and units of measure. It is based on the FHIR Head Circumference Profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Smart Health Checks AllergyIntolerance

This profile sets the minimum expectations for an AllergyIntolerance resource to record, search and save allergy or intolerance information when used within Smart Health Checks.

Smart Health Checks Blood Pressure

This profile sets the minimum expectations for a Blood Pressure resource to record, search and save blood pressure information when used within Smart Health Checks.

Smart Health Checks Body Height

This profile sets the minimum expectations for a Body Height resource to record, search and save body height information when used within Smart Health Checks.

Smart Health Checks Body Weight

This profile sets the minimum expectations for a Body Weight resource to record, search and save body weight information when used within Smart Health Checks.

Smart Health Checks Condition

This profile sets the minimum expectations for a Condition resource to record, search and save condition information when used within Smart Health Checks.

Smart Health Checks Encounter

This profile sets the minimum expectations for a Encounter resource to search and retrieve encounter information when used within Smart Health Checks.

Smart Health Checks Extract Bundle

This profile sets the expectations for a Bundle resource when used to represent a transaction bundle of resources extracted by the SHC App following the completion of a Smart Health Checks Questionnaire. This bundle is used to write patient information to the SHC Host FHIR server.

Smart Health Checks Head Circumference

This profile sets the minimum expectations for a Head Circumference resource to record, search and save head circumference information when used within Smart Health Checks.

Smart Health Checks Heart Rate

This profile sets the minimum expectations for a Heart Rate resource to record, search and save heart rate information when used within Smart Health Checks.

Smart Health Checks Heart Rhythm

This profile sets the minimum expectations for an Observation resource to record heart rhythm observations. It is used to represent heart rhythm data captured during a First Nations Health Check that can be used to record the observation in a clinical record.

Smart Health Checks Immunization

This profile sets the minimum expectations for an Immunization resource to record, search and save immunization information when used within Smart Health Checks.

Smart Health Checks Medication

This profile sets the minimum expectations for a Medication resource to search and retrieve medication information when used within Smart Health Checks.

Smart Health Checks MedicationStatement

This profile sets the minimum expectations for a MedicationStatement resource to record, search and save medication information when used within Smart Health Checks.

Smart Health Checks Patch

This profile sets the expectations for a Parameters resource when used to patch resources within Smart Health Checks.

Smart Health Checks Pathology Result

This profile sets the minimum expectations for an Observation resource to search and retrieve pathology result information when used within Smart Health Checks.

Smart Health Checks Patient

This profile sets the minimum expectations for a Patient resource to search and retrieve patient information when used within Smart Health Checks.

Smart Health Checks Practitioner

This profile sets the minimum expectations for a Practitioner resource to search and retrieve practitioner information when used within Smart Health Checks.

Smart Health Checks Questionnaire Response

This profile sets the minimum expectations for a QuestionnaireResponse resource to record, search and save form information when used within Smart Health Checks.

Smart Health Checks Smoking Status

This profile sets the minimum expectations for a Smoking Status resource to record, search and save smoking status information when used within Smart Health Checks.

Smart Health Checks Waist Circumference

This profile sets the minimum expectations for a Waist Circumference resource to record, search and save waist circumference information when used within Smart Health Checks.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Contained Resource Reference

This extension is intended to be used as a work around to a known bug whereby contained resources that are not referenced with the type, 'Reference' are removed before a resource is created in a HAPI FHIR server. This is problematic when referencing with the type, 'canonical'. The extension can be used to reference contained resources so they are retained when added to a HAPI FHIR server.

Granular Repopulate Sync

This custom extension is used to add a UI component that allows a user to repopulate an individual Questionnaire item with the latest data from the FHIR server. This is useful for updating specific items without having to refresh the entire form.

Group Hide Add Item Button

This custom extension is used to hide the UI component that allows a user to add new items for repeating groups in a Questionnaire. This is useful for preventing users from adding additional groups when it is not appropriate to do so, such as when a group is intended to be prepopulated with existing data but no new ones added by the user.

Questionnaire Item Text Hidden

This custom extension is used to indicate that the text of a Questionnaire item should be hidden in the user interface. This is useful for items where the text is not intended to be displayed to the user but is still needed for other processes.

Template Extract Extension Extended

This extension is used to extend the Extract Template - Resource extension to include additional information that supports the extraction of a Parameters resource to be used with the FHIRPath patch mechanism of updating resources. An additional subextension is included to specify the type of resource that is being patched, which is necessary for constructing the request URL of an entry in a transaction bundle.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Aboriginal and/or Torres Strait Islander

The Aboriginal and/or Torres Strait Islander value set includes the Australian Indigenous statuses for Indigenous people.

AdministrativeGender

The gender of a person used for administrative purposes.

Allergy Intolerance Clinical Status Minimal

This value set includes the minimal set of codes to represent the clinical status of an allergy intolerance (i.e., active and inactive).

Australian Medicines Terminology Vaccine

The Australian Medicines Terminology (AMT) Vaccine value set includes AMT product concepts that may be used to record a vaccine product.

Australian Pronouns

The Australian Pronouns value set includes values that indicate the pronouns to be used when communicating with or about an individual.

Australian States and Territories

The Australian States and Territories value set includes values that represent the Australian states and territories.

Biological Sex

The Biological Sex value set includes values that represent the biological sex of an individual.

Cervical Screening Status

The Cervical Screening Status value set includes values that can be used to represent the status of an individual's participation in a cervical screening program.

Clinical Condition

The Clinical Condition value set includes values that cover a broad range of clinical concepts to support the representation of conditions, including problems, diagnoses and disorders.

Condition Clinical Status Codes

Preferred value set for Condition Clinical Status.

Gender Identity Response

The Gender Identity Response value set includes values that may be used to represent a response for an individual's gender. A person's gender is a social and cultural identity, expression and experience.

Heart Rhythm

The Heart Rhythm value set includes values that may be used to represent the heart rhythm of an individual.

Medication Reason Taken

The Medication Reason Taken value set includes values that identify a reason why a medication has been or is being taken.

Medication Statement Status Limited

This value set includes the minimal set of codes to represent the status of a medication statement (i.e., active, completed, stopped and on-hold).

Primary Carer Of Parent Or Grandparent

The Primary Carer Of Parent Or Grandparent value set includes values that can indicate whether a primary carer is one of the parents or a grandparent.

Smart Health Checks Medicine Products

The Smart Health Checks Medicine Products value set includes Australian Medicines Terminology (AMT) product concepts that may be used for the identification of a medicine with form, ingredient and unit of measure details.

Smart Health Checks Patch Path

SHCPatchPath

Smoking Quit Status

The Smoking Quit Status value set includes values that can indicate how long ago an individual quit smoking.

Tobacco Use Status

The Tobacco Use Status value set includes values that may be used to represent an individual's current tobacco use and exposure status.

Yes/No

Concepts for Yes and No

Yes/No/NA

Concepts for Yes, No and Not applicable

Yes/No/Not Asked/Asked But Declined

Concepts for Yes, No, Not Asked and Asked But Declined

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Questionnaire Item Control Extension

The Questionnaire Item Control Extension code system defines concepts that extend the HL7 questionnaire item control concepts in http://hl7.org/fhir/questionnaire-item-control. They represent interface control/display mechanisms interface control/display mechanisms that might be used when rendering an item in a questionnaire.

SNOMED CT Supplement for Aboriginal and Torres Strait Islander Health Check

The SNOMED CT Supplement for Aboriginal and Torres Strait Islander Health Check code system supplement defines consumer friendly terms for use in the health check Questionnaire.

Smart Health Checks Patch Path Codes

This code system includes the codes used in the Smart Health Checks Patch Path.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

604a-pat-sf
Aboriginal and Torres Strait Islander Health Check

Aboriginal and Torres Strait Islander Health Check assessment form.

Aboriginal and Torres Strait Islander Health Check - About The Health Check

About The Health Check sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Absolute Cardiovascular Disease Risk Calculation

Absolute Cardiovascular Disease Risk Calculation sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Allergies/Adverse Reactions

Allergies/Adverse Reactions sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Chronic Disease Ageing

Chronic Disease Ageing sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Consent

Consent sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Current Priorities

Current Priorities sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Ear Health And Hearing

Ear Health And Hearing sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Examination

Examination sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Eye Health

Eye Health sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Family History

Family History sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Finalising the Health Check

Finalising the Health Check sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Gambling

Gambling sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Health Priorities, Actions And Follow-Up Summary

Health Priorities, Actions And Follow-Up Summary sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Healthy Eating

Healthy Eating sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Home And Family

Home And Family sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Immunisation

Immunisation sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Investigations

Investigations sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Learning And Development

Learning And Development sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Learning And Work

Learning And Work sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Medical History

Medical History sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Memory And Thinking

Memory And Thinking sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Mood

Mood sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Oral And Dental Health

Oral And Dental Health sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Patient Details

Patient Details sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Physical Activity And Screen Time

Physical Activity And Screen Time sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Red Flags Early Identification Guide For Children

Red Flags Early Identification Guide For Children sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Regular Medications

Regular Medications sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Screening Programs

Screening Programs sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Sexual Health

Sexual Health sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Skin

Skin sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Social And Emotional Wellbeing

Social And Emotional Wellbeing sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Social History Child

Social History Child sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

Aboriginal and Torres Strait Islander Health Check - Substance Use

Substance Use sub-questionnaire for Aboriginal and Torres Strait Islander Health Check.

chloramphenicol-pat-sf
fever-pat-sf
pat-sf
primary-peter
sdc-template-extract-928bbdd27d15