Clinical Document Architecture
2.0.0-sd-ballot - ballot

This page is part of the CDA: Clinical Document Architecture (v2.0.0-sd-ballot: CDA 2.0 Ballot 1) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: Supply (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Supply Version: 2.0.0-sd-ballot
Active as of 2023-10-27 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.

Usage:

Formal Views of Profile Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: XDocumentSubstanceMood (2.0.0) (required)
... id 0..*II
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..*CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Subject
... 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..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredXDocumentSubstanceMood
Supply.codeexampleActCode
Supply.statusCoderequiredActStatus
Supply.priorityCodeexampleActPriority
Supply.product.typeCoderequiredFixed Value: PRD
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: XDocumentSubstanceMood (2.0.0) (required)
... id 0..*II
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..*CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Subject
... 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..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredXDocumentSubstanceMood
Supply.codeexampleActCode
Supply.statusCoderequiredActStatus
Supply.priorityCodeexampleActPriority
Supply.product.typeCoderequiredFixed Value: PRD
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... templateId 0..*II
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: XDocumentSubstanceMood (2.0.0) (required)
... id 0..*II
... code 0..1CDBinding: v3 Code System ActCode (example)
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..*CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Subject
... 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..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.nullFlavorrequiredCDANullFlavor
Supply.typeId.nullFlavorrequiredCDANullFlavor
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredXDocumentSubstanceMood
Supply.codeexampleActCode
Supply.statusCoderequiredActStatus
Supply.priorityCodeexampleActPriority
Supply.product.nullFlavorrequiredCDANullFlavor
Supply.product.typeId.nullFlavorrequiredCDANullFlavor
Supply.product.typeCoderequiredFixed Value: PRD

This structure is derived from InfrastructureRoot

Summary

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

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: XDocumentSubstanceMood (2.0.0) (required)
... id 0..*II
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..*CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Subject
... 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..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredXDocumentSubstanceMood
Supply.codeexampleActCode
Supply.statusCoderequiredActStatus
Supply.priorityCodeexampleActPriority
Supply.product.typeCoderequiredFixed Value: PRD

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: XDocumentSubstanceMood (2.0.0) (required)
... id 0..*II
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..*CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1InfrastructureRoot
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Subject
... 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..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredXDocumentSubstanceMood
Supply.codeexampleActCode
Supply.statusCoderequiredActStatus
Supply.priorityCodeexampleActPriority
Supply.product.typeCoderequiredFixed Value: PRD

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... templateId 0..*II
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: XDocumentSubstanceMood (2.0.0) (required)
... id 0..*II
... code 0..1CDBinding: v3 Code System ActCode (example)
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..*CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Subject
... 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..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.nullFlavorrequiredCDANullFlavor
Supply.typeId.nullFlavorrequiredCDANullFlavor
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredXDocumentSubstanceMood
Supply.codeexampleActCode
Supply.statusCoderequiredActStatus
Supply.priorityCodeexampleActPriority
Supply.product.nullFlavorrequiredCDANullFlavor
Supply.product.typeId.nullFlavorrequiredCDANullFlavor
Supply.product.typeCoderequiredFixed Value: PRD

This structure is derived from InfrastructureRoot

Summary

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

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel