0.1.0 - ci-build

collabreefhirdocumentation - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Artifacts Summary

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

Structures: Resource Profiles

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

Collabree Adherence Observation Profile

Profile for medication adherence observations in the Collabree system, tracking daily adherence scores, streaks, and balance rewards. Each component represents adherence data for exactly one day - there should be one component per day with no duplicates.

Collabree Care Plan Profile

Profile for care plans in the Collabree adherence tracking system

Collabree Claim Profile

A claim profile for Collabree system with required fields for adherence-based financial claims.

Collabree Coverage Profile

A coverage profile for Collabree system with required fields for adherence-based insurance coverage.

Collabree Medication Profile

Unified profile for all medications available in the Collabree system, supporting both Swiss and Arab medication catalogs with country-specific attributes and terminology

Collabree Medication Request Profile

Profile for medication requests in the Collabree system, supporting medication adherence tracking with specific dosage instructions and timing

Collabree Medication Statement Profile

Profile for medication statements in the Collabree system, tracking actual medication intake based on medication requests

Collabree Organization Profile

An organization profile for Collabree system with required extensions and constraints for managing patient adherence programs.

Collabree Patient Profile

Profile of the Patient resource for use in Collabree's system

Collabree Plan Definition Profile

Profile for medication plans in the Collabree adherence tracking system

Collabree Questionnaire Library Profile

A library containing questionnaire attachments for the Collabree system

Collabree Questionnaire Profile

Profile for questionnaires used in the Collabree adherence tracking system with multi-language support and scoring capabilities

Collabree Questionnaire Response Profile

Profile for questionnaires response

Collabree Trophy Profile

A trophy represents an achievement earned by a patient in the Collabree adherence tracking system. Trophies are automatically calculated and awarded based on adherence patterns, quiz completions, and system interactions.

Structures: Extension Definitions

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

Adherence Threshold

Minimum adherence percentage threshold

Balance Calculation

Extension for storing the calculated reward balance earned through adherence

Balance Currency

Currency code for the balance amount

Best Adherence Score Calculation

Extension for storing the calculated best adherence score achieved (normalized 0-1)

Best Streak Calculation

Extension for storing the calculated best adherence streak achieved (non-negative)

Cheat Days

Number of allowed cheat days

Collabree Questionnaire Answer Option Feedback Message

Extension for providing feedback messages for questionnaire answer options

Country code

Indicates country code of the resource

Daily Adherence Score Calculation

Extension for storing the calculated daily adherence score for medication intake (normalized 0-1)

Daily Streak Calculation

Extension for storing the calculated current daily adherence streak count (non-negative)

Initial Balance

Initial balance amount for adherence tracking

Loss Per Day

Amount lost per day for non-adherence

Medication Expiration in Months

Extension for specifying medication expiration period in months

Medication Image URL

Extension for specifying medication image via URI reference

Number of Payouts

Total number of payouts allowed

Organization Fallback Plan Definition

Reference to the fallback adherence plan definition associated with this organization.

Organization Primary Plan Definition

Reference to the primary adherence plan definition associated with this organization.

Payout Period in Days

Number of days for payout period

Total Adherence Score Calculation

Extension for storing the calculated total adherence score across all tracked days (normalized 0-1)

Terminology: Value Sets

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

Collabree Allowed Country Value Set

Value set defining the countries where Collabree services are available

Collabree Organization Type Value Set

Value set containing organization types used in the Collabree system.

Collabree Questionnaire Category Value Set

Value set defining the specific LOINC questionnaire categories allowed in Collabree questionnaires

Collabree Trophy Type Value Set

Value set defining the different types of trophies that can be earned by patients in the Collabree adherence tracking system

Data Provider ID Value Set

Value set defining the different data providers for medication catalogs in the Collabree system

Medication Intake Calculations Value Set

Value set defining the different types of medication intake calculations in the Collabree adherence tracking system

Observation Version Type Value Set

Value set defining the different version types for observations in the Collabree adherence tracking system

Timing Event Value Set

Value set for medication timing events in the Collabree system

Terminology: Code Systems

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

Collabree Organization Type Code System

Code system for organization types in the Collabree system.

Collabree Trophy Type Code System

Code system defining the different types of trophies available in the Collabree system

Data Provider ID Code System

Code system defining the different data providers available for medication catalogs

Medication Intake Calculations Code System

Code system defining the different types of medication intake calculations available in the Collabree system

Observation Version Type Code System

Code system defining the different version types for observations in the Collabree system

Example: Example Instances

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

Collabree Medication Plan

An example CollabreeCarePlan with adherence tracking extensions

Collabree Medication Plan

An example CollabreePlanDefinition with adherence tracking extensions

SampleAdherenceObservation

An example adherence observation showing daily medication adherence tracking with scores and streaks

SampleArabMedication

An example Saudi Arabian medication with Arab-specific attributes and Arabic terminology

SampleClaim

Sample claim for adherence-based financial transaction

SampleCollabreeQuestionnaire

An example CollabreeQuestionnaire with question and score items

SampleCollabreeQuestionnaireResponse

An example CollabreeQuestionnaireResponse with answer and score

SampleCoverage

Sample coverage for adherence-based insurance

SampleMedicationRequest

An example medication request showing weekly dosage with specific timing

SampleMedicationStatement

An example medication statement showing completed medication intake

SampleOrganization

Managing organization for the example patient

SamplePatient

An example CollabreePatient with all fields

SampleQuestionnaireLibrary

An example CollabreeQuestionnaireLibrary

SampleRootOrganization

Managing root organization for the example patient

SampleSwissMedication

An example Swiss medication with Swiss-specific attributes and multilingual support

SampleTrophy

An example trophy for perfect day achievement