Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ and changes regularly. See the Directory of published versions

Logical Model: Supply (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Supply Version: 1.0.1
Active as of 2025-10-09 Maturity Level: 1 Responsible: HL7 Computable Name: Supply

A derivative of the RIM Supply class, used for representing the provision of a material by one entity to another.

The dispensed product is associated with the Supply act via a product participant, which connects to the same ManufacturedProduct role used for SubstanceAdministration.

The Supply class represents dispensing, whereas the SubstanceAdministration class represents administration. Prescriptions are complex activities that involve both an administration request to the patient (e.g. take digoxin 0.125mg by mouth once per day) and a supply request to the pharmacy (e.g. dispense 30 tablets, with 5 refills). This should be represented in CDA by a SubstanceAdministration entry that has a component Supply entry. The nested Supply entry can have Supply.independentInd set to "false" to signal that the Supply cannot stand alone, without it's containing SubstanceAdministration. The following example illustrates a prescription representation in CDA.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Supply 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... templateId 0..* II
... @classCode 1..1 cs Binding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1 cs Binding: XDocumentSubstanceMood (2.0.0) (required)
... id 0..* II
... code 0..1 CD Binding: v3 Code System ActCode (example)
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTime SXCM_TS
.... effectiveTime IVL_TS
.... effectiveTime EIVL_TS
.... effectiveTime PIVL_TS
.... effectiveTime SXPR_TS
... priorityCode 0..* CE Binding: ActPriority (example)
... repeatNumber 0..1 IVL_INT
... independentInd 0..1 BL
... quantity 0..1 PQ
... expectedUseTime 0..1 IVL_TS
... product 0..1 InfrastructureRoot
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId C 0..1 II Constraints: II-1
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Binding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1 ManufacturedProduct
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Supply.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.typeId.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.classCode Base required ActClassSupply 📦2.0.0 THO v5.2
Supply.moodCode Base required x_DocumentSubstanceMood 📍2.0.0 THO v5.2
Supply.code Base example v3 Code System ActCode 📦2.0.0 THO v5.2
Supply.statusCode Base required ActStatus 📦2.0.0 THO v5.2
Supply.priorityCode Base example ActPriority 📦2.0.0 THO v5.2
Supply.product.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.product.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.product.typeCode Base required ParticipationTargetDirect 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error Supply.typeId, Supply.product.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Supply 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 1..1 cs Binding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1 cs Binding: XDocumentSubstanceMood (2.0.0) (required)
... id 0..* II
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTime SXCM_TS
.... effectiveTime IVL_TS
.... effectiveTime EIVL_TS
.... effectiveTime PIVL_TS
.... effectiveTime SXPR_TS
... priorityCode 0..* CE Binding: ActPriority (example)
... repeatNumber 0..1 IVL_INT
... independentInd 0..1 BL
... quantity 0..1 PQ
... expectedUseTime 0..1 IVL_TS
... product 0..1 InfrastructureRoot
.... @typeCode 0..1 cs Binding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1 ManufacturedProduct
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Supply.classCode Base required ActClassSupply 📦2.0.0 THO v5.2
Supply.moodCode Base required x_DocumentSubstanceMood 📍2.0.0 THO v5.2
Supply.code Base example v3 Code System ActCode 📦2.0.0 THO v5.2
Supply.statusCode Base required ActStatus 📦2.0.0 THO v5.2
Supply.priorityCode Base example ActPriority 📦2.0.0 THO v5.2
Supply.product.typeCode Base required ParticipationTargetDirect 📦2.0.0 THO v5.2
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Supply 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... templateId 0..* II
... @classCode 1..1 cs Binding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1 cs Binding: XDocumentSubstanceMood (2.0.0) (required)
... id 0..* II
... code 0..1 CD Binding: v3 Code System ActCode (example)
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTime SXCM_TS
.... effectiveTime IVL_TS
.... effectiveTime EIVL_TS
.... effectiveTime PIVL_TS
.... effectiveTime SXPR_TS
... priorityCode 0..* CE Binding: ActPriority (example)
... repeatNumber 0..1 IVL_INT
... independentInd 0..1 BL
... quantity 0..1 PQ
... expectedUseTime 0..1 IVL_TS
... product 0..1 InfrastructureRoot
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId C 0..1 II Constraints: II-1
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Binding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1 ManufacturedProduct
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Supply.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.typeId.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.classCode Base required ActClassSupply 📦2.0.0 THO v5.2
Supply.moodCode Base required x_DocumentSubstanceMood 📍2.0.0 THO v5.2
Supply.code Base example v3 Code System ActCode 📦2.0.0 THO v5.2
Supply.statusCode Base required ActStatus 📦2.0.0 THO v5.2
Supply.priorityCode Base example ActPriority 📦2.0.0 THO v5.2
Supply.product.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.product.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.product.typeCode Base required ParticipationTargetDirect 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error Supply.typeId, Supply.product.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(3 nested mandatory elements)
Fixed: 2 elements

Structures

This structure refers to these other structures:

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Supply 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... templateId 0..* II
... @classCode 1..1 cs Binding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1 cs Binding: XDocumentSubstanceMood (2.0.0) (required)
... id 0..* II
... code 0..1 CD Binding: v3 Code System ActCode (example)
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTime SXCM_TS
.... effectiveTime IVL_TS
.... effectiveTime EIVL_TS
.... effectiveTime PIVL_TS
.... effectiveTime SXPR_TS
... priorityCode 0..* CE Binding: ActPriority (example)
... repeatNumber 0..1 IVL_INT
... independentInd 0..1 BL
... quantity 0..1 PQ
... expectedUseTime 0..1 IVL_TS
... product 0..1 InfrastructureRoot
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId C 0..1 II Constraints: II-1
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Binding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1 ManufacturedProduct
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Supply.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.typeId.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.classCode Base required ActClassSupply 📦2.0.0 THO v5.2
Supply.moodCode Base required x_DocumentSubstanceMood 📍2.0.0 THO v5.2
Supply.code Base example v3 Code System ActCode 📦2.0.0 THO v5.2
Supply.statusCode Base required ActStatus 📦2.0.0 THO v5.2
Supply.priorityCode Base example ActPriority 📦2.0.0 THO v5.2
Supply.product.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.product.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.product.typeCode Base required ParticipationTargetDirect 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error Supply.typeId, Supply.product.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Supply 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 1..1 cs Binding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1 cs Binding: XDocumentSubstanceMood (2.0.0) (required)
... id 0..* II
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTime SXCM_TS
.... effectiveTime IVL_TS
.... effectiveTime EIVL_TS
.... effectiveTime PIVL_TS
.... effectiveTime SXPR_TS
... priorityCode 0..* CE Binding: ActPriority (example)
... repeatNumber 0..1 IVL_INT
... independentInd 0..1 BL
... quantity 0..1 PQ
... expectedUseTime 0..1 IVL_TS
... product 0..1 InfrastructureRoot
.... @typeCode 0..1 cs Binding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1 ManufacturedProduct
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Supply.classCode Base required ActClassSupply 📦2.0.0 THO v5.2
Supply.moodCode Base required x_DocumentSubstanceMood 📍2.0.0 THO v5.2
Supply.code Base example v3 Code System ActCode 📦2.0.0 THO v5.2
Supply.statusCode Base required ActStatus 📦2.0.0 THO v5.2
Supply.priorityCode Base example ActPriority 📦2.0.0 THO v5.2
Supply.product.typeCode Base required ParticipationTargetDirect 📦2.0.0 THO v5.2

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Supply 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... templateId 0..* II
... @classCode 1..1 cs Binding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1 cs Binding: XDocumentSubstanceMood (2.0.0) (required)
... id 0..* II
... code 0..1 CD Binding: v3 Code System ActCode (example)
... text 0..1 ED
... statusCode 0..1 CS Binding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTime SXCM_TS
.... effectiveTime IVL_TS
.... effectiveTime EIVL_TS
.... effectiveTime PIVL_TS
.... effectiveTime SXPR_TS
... priorityCode 0..* CE Binding: ActPriority (example)
... repeatNumber 0..1 IVL_INT
... independentInd 0..1 BL
... quantity 0..1 PQ
... expectedUseTime 0..1 IVL_TS
... product 0..1 InfrastructureRoot
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId C 0..1 II Constraints: II-1
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Binding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1 ManufacturedProduct
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Supply.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.typeId.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.classCode Base required ActClassSupply 📦2.0.0 THO v5.2
Supply.moodCode Base required x_DocumentSubstanceMood 📍2.0.0 THO v5.2
Supply.code Base example v3 Code System ActCode 📦2.0.0 THO v5.2
Supply.statusCode Base required ActStatus 📦2.0.0 THO v5.2
Supply.priorityCode Base example ActPriority 📦2.0.0 THO v5.2
Supply.product.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.product.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
Supply.product.typeCode Base required ParticipationTargetDirect 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error Supply.typeId, Supply.product.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(3 nested mandatory elements)
Fixed: 2 elements

Structures

This structure refers to these other structures:

Maturity: 1

 

Other representations of profile: CSV, Excel