This page is part of the CDA: Clinical Document Architecture (v2.0.1-sd: CDA 2.0 - Informative) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Supply | Version: 2.0.1-sd | |||
Active as of 2024-12-18 | 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:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from InfrastructureRoot
Path | Conformance | ValueSet / Code | URI |
Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
Supply.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
Supply.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect |
Path | Conformance | ValueSet / Code | URI |
Supply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
Supply.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
Supply.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Supply.product.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Supply.typeId, Supply.product.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
Path | Conformance | ValueSet / Code | URI |
Supply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
Supply.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
Supply.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Supply.product.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect |
Id | Grade | Path(s) | Details | Requirements |
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
Differential View
This structure is derived from InfrastructureRoot
Path | Conformance | ValueSet / Code | URI |
Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
Supply.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
Supply.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect |
Key Elements View
Path | Conformance | ValueSet / Code | URI |
Supply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
Supply.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
Supply.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Supply.product.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Supply.typeId, Supply.product.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
Snapshot View
Path | Conformance | ValueSet / Code | URI |
Supply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
Supply.moodCode | required | XDocumentSubstanceMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 | |
Supply.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Supply.product.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect |
Id | Grade | Path(s) | Details | Requirements |
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