# Common Components FHIR Implementation Guide

26.0.0 - Trial

Common Components FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 26.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/common-components/ and changes regularly. See the Directory of published versions

## FHIR Artefacts

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

### Structures: Data Type Profiles

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

CDA Instance Identifier | Identifier datatype profile for representing the source CDA document instance identifier in a FHIR context. The identifier value is expressed as a URN OID (urn:ietf:rfc:3986), with the assigner carrying the PCEHR repository OID and display name.
Peak Body Professional Registration Number (PBPRN) | This identifier profile defines a peak body (non-Ahpra) professional registration number allocated to a healthcare practitioner

### Structures: Extension Definitions

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

Active Period | The period during which the HealthcareService is considered active.
Alternate Name | This extension applies to PractitionerRole, and represents a name by which a practitioner chooses to be known in the context of the delivery of a specific healthcare service.
Amenity | Physical features or amenities available within, or in close proximity of, a location. Uses the NCTS Facility Amenity ValueSet.
IAR Levels of Care | Indicates the IAR (Initial Assessment and Referral) Levels of Care for a healthcare service.
Medication Additional Therapeutic Good Detail String | Supplemental descriptive information such as physical appearance or packaging (e.g., 'White, round tablet with ABC123 imprint') captured from CDA manufactured material descriptions.
Medication Dispense Maximum Number Of Repeats | The maximum number of repeat supplies authorised for a therapeutic good, not including the initial supply. Equivalent to MedicationRequest.dispenseRequest.numberOfRepeatsAllowed.
Medication Dispense Quantity Description | Human-readable quantity descriptions (e.g., '30 tablets (1 month supply)') to supplement structured quantity data in Medication resources.
Medication Dispense Repeat Status Code | Indicates whether this MedicationDispense represents an active repeat (more repeats to be dispensed) or a completed repeat (the last repeat has been dispensed).
Medication Dispense Unique Prescription Number String | Captures pharmacy-assigned tracking numbers for specific prescription instances, as distinct from the clinician's prescription identifier.
Medication Formula String | Captures compounded medication formulas from CDA entry relationships to provide formula information in FHIR Medication resources for the PCEHR Prescription and Dispense View.
New Patient Availability | Indicates whether the healthcare service is accepting new patients. Patterned after PCA New Patient Availability extension. Context of Use: HealthcareService
Practitioner Role Communication | Practitioner Role Communication. This extension captures communication preferences and capabilities for a practitioner in a given role.
Referral Information for Referrer | Referral instructions and information for healthcare service providers that may wish to refer patients / clients to the healthcare service.
Source CDA Document Identifier | The instance identifier of the source CDA clinical document from which this FHIR resource was derived. Carries the `/ClinicalDocument/id` value to preserve source document provenance in a FHIR context.
Suppression Indicator for Visibility | Indicates whether the parent resource should be hidden from display in the Provider Directory. Contains coded information about the actor who initiated the suppression and optional control flags.

### Terminology: Value Sets

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

Identifier Type | Identifier type codes for use in ADHA data format mapping FHIR profiles.
MedicationDispense Repeat Status | Allowed values for the MedicationDispense repeat status extension: active if more repeats are to be dispensed, or completed if the last repeat has been dispensed.
Responsible Party Type | ValueSet containing codes that indicate the resource type of the party that is responsible for the current value of a data element.

### Terminology: Code Systems

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

Identifier Type | Identifier type codes defined for use in ADHA data format mapping FHIR profiles, supplementing HL7 v2 Table 0203 where no suitable standard code exists.
MedicationDispense Repeat Status | Status codes indicating whether a medication dispense represents an active repeat (more repeats to be dispensed) or a completed repeat (last repeat has been dispensed).
Responsible Party Type | CodeSystem containing codes that indicate the resource type of the party that is responsible for the current value of a data element.

### Example: Example Instances

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

Active Period Example | A HealthcareService example showing an active period for the service.
Alternate Name Example | A PractitionerRole example with alternate name extension.
IAR Levels of Care Example | A HealthcareService example with IAR levels of care extension.
Medication CDA Extensions Example | A Medication example demonstrating common CDA-derived medication descriptive extensions for a commercial tablet pack represented with SNOMED AMT and PBS coding.
MedicationDispense CDA Extensions Example | A MedicationDispense example for a commercial tablet pack demonstrating CDA-derived dispense extensions including repeat status and source document identifier.
MedicationDispense Repeat Progression Example 1 of 6 | Dispense 1 of 6 for a commercial tablet pack medication. Repeat status is active.
MedicationDispense Repeat Progression Example 2 of 6 | Dispense 2 of 6 for a commercial tablet pack medication. Repeat status remains active.
MedicationDispense Repeat Progression Example 3 of 6 | Dispense 3 of 6 for a commercial tablet pack medication. Repeat status remains active.
MedicationDispense Repeat Progression Example 4 of 6 | Dispense 4 of 6 for a commercial tablet pack medication. Repeat status remains active.
MedicationDispense Repeat Progression Example 5 of 6 | Dispense 5 of 6 for a commercial tablet pack medication. Repeat status remains active.
MedicationDispense Repeat Progression Example 6 of 6 (Final) | Dispense 6 of 6 for a commercial tablet pack medication. Repeat status is completed with no further repeats remaining.
MedicationRequest CDA Extensions Example | A MedicationRequest example for a commercial tablet pack demonstrating CDA-derived source document and quantity description extensions.
New Patient Availability Example | A HealthcareService example showing new patient availability extension.
Practitioner Role Communication Example | A PractitionerRole example with practitioner role communication extension.
Referral Information for Referrer Example | A HealthcareService example with referral information for referrer extension.
Suppressed Organization Example | An Organization example with the suppression extension.
Suppressed PractitionerRole Example | A PractitionerRole example with the suppression extension.
location-amenity-example | A sample clinic location with wheelchair access.