Clinical Document Architecture V2.1
2.1.0 - CI Build

Clinical Document Architecture V2.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

StructureDefinition: 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.

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

Summary

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

This structure is derived from

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1
... classCode 1..1codeBinding: V3 Value SetActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1code
... templateId 0..*II
... text 0..1ED
... statusCode 0..1CSBinding: v3 Code System ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM-TS
.... effectiveTimeIVL-TS
.... effectiveTimeEIVL-TS
.... effectiveTimePIVL-TS
.... effectiveTimeSXPR-TS
... priorityCode 0..*CEBinding: v3 Code System ActPriority (extensible)
... repeatNumber 0..1IVL-INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL-TS
... product 0..1Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: v3 Code System ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: v3 Code System TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL-TS
.... modeCode 0..1CEBinding: v3 Code System ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: v3 Code System ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Element
.... typeCode 1..1codeBinding: v3 Code System ParticipationType (required)
.... contextControlCode 1..1codeBinding: v3 Code System ContextControl (required)
Fixed Value: OP
.... time 0..1IVL-TS
.... awarenessCode 0..1CEBinding: v3 Code System TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship 0..*Element
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... 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: V3 Value SetActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1
... classCode 1..1codeBinding: V3 Value SetActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1code
... templateId 0..*II
... text 0..1ED
... statusCode 0..1CSBinding: v3 Code System ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM-TS
.... effectiveTimeIVL-TS
.... effectiveTimeEIVL-TS
.... effectiveTimePIVL-TS
.... effectiveTimeSXPR-TS
... priorityCode 0..*CEBinding: v3 Code System ActPriority (extensible)
... repeatNumber 0..1IVL-INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL-TS
... product 0..1Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: v3 Code System ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: v3 Code System TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL-TS
.... modeCode 0..1CEBinding: v3 Code System ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: v3 Code System ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Element
.... typeCode 1..1codeBinding: v3 Code System ParticipationType (required)
.... contextControlCode 1..1codeBinding: v3 Code System ContextControl (required)
Fixed Value: OP
.... time 0..1IVL-TS
.... awarenessCode 0..1CEBinding: v3 Code System TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship 0..*Element
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... 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: V3 Value SetActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format

This structure is derived from

Summary

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

Differential View

This structure is derived from

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1
... classCode 1..1codeBinding: V3 Value SetActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1code
... templateId 0..*II
... text 0..1ED
... statusCode 0..1CSBinding: v3 Code System ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM-TS
.... effectiveTimeIVL-TS
.... effectiveTimeEIVL-TS
.... effectiveTimePIVL-TS
.... effectiveTimeSXPR-TS
... priorityCode 0..*CEBinding: v3 Code System ActPriority (extensible)
... repeatNumber 0..1IVL-INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL-TS
... product 0..1Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: v3 Code System ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: v3 Code System TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL-TS
.... modeCode 0..1CEBinding: v3 Code System ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: v3 Code System ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Element
.... typeCode 1..1codeBinding: v3 Code System ParticipationType (required)
.... contextControlCode 1..1codeBinding: v3 Code System ContextControl (required)
Fixed Value: OP
.... time 0..1IVL-TS
.... awarenessCode 0..1CEBinding: v3 Code System TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship 0..*Element
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... 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: V3 Value SetActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1
... classCode 1..1codeBinding: V3 Value SetActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1code
... templateId 0..*II
... text 0..1ED
... statusCode 0..1CSBinding: v3 Code System ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM-TS
.... effectiveTimeIVL-TS
.... effectiveTimeEIVL-TS
.... effectiveTimePIVL-TS
.... effectiveTimeSXPR-TS
... priorityCode 0..*CEBinding: v3 Code System ActPriority (extensible)
... repeatNumber 0..1IVL-INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL-TS
... product 0..1Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: v3 Code System ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: v3 Code System TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationTargetDirect (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole
... performer 0..*Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... time 0..1IVL-TS
.... modeCode 0..1CEBinding: v3 Code System ParticipationMode (extensible)
.... assignedEntity 1..1AssignedEntity
... author 0..*Author
... informant 0..*Element
.... typeCode 1..1codeBinding: V3 Value SetParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: v3 Code System ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Element
.... typeCode 1..1codeBinding: v3 Code System ParticipationType (required)
.... contextControlCode 1..1codeBinding: v3 Code System ContextControl (required)
Fixed Value: OP
.... time 0..1IVL-TS
.... awarenessCode 0..1CEBinding: v3 Code System TargetAwareness (extensible)
.... participantRole 1..1ParticipantRole
... entryRelationship 0..*Element
.... typeCode 1..1code
.... inversionInd 0..1boolean
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... negationInd 0..1boolean
.... seperatableInd 0..1BL
.... 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: V3 Value SetActRelationshipConditional (required)
Fixed Value: PRCN
.... criterion 1..1Criterion

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.codeextensiblev3.ActCode
Supply.statusCoderequiredv3.ActStatus
Supply.priorityCodeextensiblev3.ActPriority
Supply.product.typeCoderequiredFixed Value: PRD
Supply.subject.typeCoderequiredFixed Value: SBJ
Supply.subject.contextControlCoderequiredFixed Value: OP
Supply.subject.awarenessCodeextensiblev3.TargetAwareness
Supply.specimen.typeCoderequiredFixed Value: SPC
Supply.performer.typeCoderequiredFixed Value: PRF
Supply.performer.modeCodeextensiblev3.ParticipationMode
Supply.informant.typeCoderequiredFixed Value: INF
Supply.informant.contextControlCoderequiredFixed Value: OP
Supply.participant.typeCoderequiredv3.ParticipationType
Supply.participant.contextControlCoderequiredFixed Value: OP
Supply.participant.awarenessCodeextensiblev3.TargetAwareness
Supply.precondition.typeCoderequiredFixed Value: PRCN

Constraints

Constraints

IdPathDetailsRequirements