This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/cda/StructureDefinition/Supply | Version: 2.1.0-draft1 | |||
Active as of 2023-01-16 | Computable Name: CDAR2Supply |
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 Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.code | extensible | ActCode |
Supply.statusCode | required | ActStatus |
Supply.priorityCode | extensible | ActPriority |
Supply.product.typeCode | required | Fixed Value: PRD |
Supply.subject.typeCode | required | Fixed Value: SBJ |
Supply.subject.contextControlCode | required | Fixed Value: OP |
Supply.subject.awarenessCode | extensible | TargetAwareness |
Supply.informant.typeCode | required | Fixed Value: INF |
Supply.informant.contextControlCode | required | Fixed Value: OP |
Id | Grade | Path(s) | Details | Requirements |
sup-er-1 | error | Supply.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.code | extensible | ActCode |
Supply.statusCode | required | ActStatus |
Supply.priorityCode | extensible | ActPriority |
Supply.product.typeCode | required | Fixed Value: PRD |
Supply.subject.typeCode | required | Fixed Value: SBJ |
Supply.subject.contextControlCode | required | Fixed Value: OP |
Supply.subject.awarenessCode | extensible | TargetAwareness |
Supply.informant.typeCode | required | Fixed Value: INF |
Supply.informant.contextControlCode | required | Fixed Value: OP |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
sup-er-1 | error | Supply.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.code | extensible | ActCode |
Supply.statusCode | required | ActStatus |
Supply.priorityCode | extensible | ActPriority |
Supply.product.typeCode | required | Fixed Value: PRD |
Supply.subject.typeCode | required | Fixed Value: SBJ |
Supply.subject.contextControlCode | required | Fixed Value: OP |
Supply.subject.awarenessCode | extensible | TargetAwareness |
Supply.informant.typeCode | required | Fixed Value: INF |
Supply.informant.contextControlCode | required | Fixed Value: OP |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
sup-er-1 | error | Supply.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
This structure is derived from Base
Differential View
This structure is derived from Base
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.code | extensible | ActCode |
Supply.statusCode | required | ActStatus |
Supply.priorityCode | extensible | ActPriority |
Supply.product.typeCode | required | Fixed Value: PRD |
Supply.subject.typeCode | required | Fixed Value: SBJ |
Supply.subject.contextControlCode | required | Fixed Value: OP |
Supply.subject.awarenessCode | extensible | TargetAwareness |
Supply.informant.typeCode | required | Fixed Value: INF |
Supply.informant.contextControlCode | required | Fixed Value: OP |
Id | Grade | Path(s) | Details | Requirements |
sup-er-1 | error | Supply.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
Key Elements View
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.code | extensible | ActCode |
Supply.statusCode | required | ActStatus |
Supply.priorityCode | extensible | ActPriority |
Supply.product.typeCode | required | Fixed Value: PRD |
Supply.subject.typeCode | required | Fixed Value: SBJ |
Supply.subject.contextControlCode | required | Fixed Value: OP |
Supply.subject.awarenessCode | extensible | TargetAwareness |
Supply.informant.typeCode | required | Fixed Value: INF |
Supply.informant.contextControlCode | required | Fixed Value: OP |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
sup-er-1 | error | Supply.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
Snapshot View
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.code | extensible | ActCode |
Supply.statusCode | required | ActStatus |
Supply.priorityCode | extensible | ActPriority |
Supply.product.typeCode | required | Fixed Value: PRD |
Supply.subject.typeCode | required | Fixed Value: SBJ |
Supply.subject.contextControlCode | required | Fixed Value: OP |
Supply.subject.awarenessCode | extensible | TargetAwareness |
Supply.informant.typeCode | required | Fixed Value: INF |
Supply.informant.contextControlCode | required | Fixed Value: OP |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
sup-er-1 | error | Supply.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
This structure is derived from Base