Clinical Document Architecture V2.0.1
2.1.0 - CI Build

Clinical Document Architecture V2.0.1, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: Supply (CDA Class)

Defining URL:http://hl7.org/fhir/cda/StructureDefinition/Supply
Version:2.1.0
Name:CDAR2Supply
Title:Supply (CDA Class)
Status:Active as of 2020-11-19T18:06:12+00:00
Definition:

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.

Publisher:Health Level 7
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/cda/StructureDefinition/Supply

Formal Views of Profile Content

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

This structure is derived from Base

Summary

Mandatory: 0 element (21 nested mandatory elements)
Fixed Value: 10 elements

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1code
... templateId 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 (extensible)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL_TS
.... modeCode 0..1CEBinding: ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Element
.... typeCode 1..1codeBinding: ParticipationType (required)
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... time 0..1IVL_TS
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship I0..*Elementsup-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... observation 0..1Observation
..... regionOfInterest 0..1RegionOfInterest
..... observationMedia 0..1ObservationMedia
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
..... procedure 0..1Procedure
..... encounter 0..1Encounter
..... organizer 0..1Organizer
..... act 0..1Act
... reference 0..*Element
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Element
.... typeCode 1..1codeBinding: ActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1code
... templateId 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 (extensible)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL_TS
.... modeCode 0..1CEBinding: ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Element
.... typeCode 1..1codeBinding: ParticipationType (required)
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... time 0..1IVL_TS
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship I0..*Elementsup-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... observation 0..1Observation
..... regionOfInterest 0..1RegionOfInterest
..... observationMedia 0..1ObservationMedia
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
..... procedure 0..1Procedure
..... encounter 0..1Encounter
..... organizer 0..1Organizer
..... act 0..1Act
... reference 0..*Element
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Element
.... typeCode 1..1codeBinding: ActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element (21 nested mandatory elements)
Fixed Value: 10 elements

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1code
... templateId 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 (extensible)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL_TS
.... modeCode 0..1CEBinding: ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Element
.... typeCode 1..1codeBinding: ParticipationType (required)
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... time 0..1IVL_TS
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship I0..*Elementsup-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... observation 0..1Observation
..... regionOfInterest 0..1RegionOfInterest
..... observationMedia 0..1ObservationMedia
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
..... procedure 0..1Procedure
..... encounter 0..1Encounter
..... organizer 0..1Organizer
..... act 0..1Act
... reference 0..*Element
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Element
.... typeCode 1..1codeBinding: ActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1code
... templateId 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 (extensible)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL_TS
.... modeCode 0..1CEBinding: ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Element
.... typeCode 1..1codeBinding: ParticipationType (required)
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... time 0..1IVL_TS
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship I0..*Elementsup-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... (Choice of one) 1..1
..... observation 0..1Observation
..... regionOfInterest 0..1RegionOfInterest
..... observationMedia 0..1ObservationMedia
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
..... procedure 0..1Procedure
..... encounter 0..1Encounter
..... organizer 0..1Organizer
..... act 0..1Act
... reference 0..*Element
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Element
.... typeCode 1..1codeBinding: ActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.codeextensibleActCode
Supply.statusCoderequiredActStatus
Supply.priorityCodeextensibleActPriority
Supply.product.typeCoderequiredFixed Value: PRD
Supply.subject.typeCoderequiredFixed Value: SBJ
Supply.subject.contextControlCoderequiredFixed Value: OP
Supply.subject.awarenessCodeextensibleTargetAwareness
Supply.specimen.typeCoderequiredFixed Value: SPC
Supply.performer.typeCoderequiredFixed Value: PRF
Supply.performer.modeCodeextensibleParticipationMode
Supply.informant.typeCoderequiredFixed Value: INF
Supply.informant.contextControlCoderequiredFixed Value: OP
Supply.participant.typeCoderequiredParticipationType
Supply.participant.contextControlCoderequiredFixed Value: OP
Supply.participant.awarenessCodeextensibleTargetAwareness
Supply.precondition.typeCoderequiredFixed Value: PRCN

Constraints

IdPathDetailsRequirements
sup-er-1Supply.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1