Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: Planned Supply

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedSupply Version: 2.1
Draft as of 2023-09-29 Computable Name: PlannedSupply
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.43:2014-06-09

This template represents both medicinal and non-medicinal supplies ordered, requested, or intended for the patient (e.g., medication prescription, order for wheelchair). The importance of the supply order or request to the patient and provider may be indicated in the Priority Preference. The effective time indicates the time when the supply is intended to take place and author time indicates when the documentation of the plan occurred. The Planned Supply template may also indicate the potential insurance coverage for the procedure. Depending on the type of supply, the product or participant will be either a Medication Information product (medication), an Immunization Medication Information product (immunization), or a Product Instance participant (device/equipment).

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2Supply

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply CDAR2SupplyXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
... classCode 1..1cs
... moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.43
..... extension 1..1stRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1csFixed Value: active
... effectiveTime 0..1SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TSThe effectiveTime in a planned supply represents the time that the supply should occur.
... repeatNumber 0..1IVL_INTIn a Planned Supply, repeatNumber indicates the number of times the supply event can occur. For example, if a medication is filled at a pharmacy and the prescription may be refilled 3 more times, the supply RepeatNumber equals 4.
... quantity 0..1PQ
... product C0..1InfrastructureRootA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
1098-32325: SHOULD contain zero or one [0..1] product (CONF:1098-32325).
1098-32092: If the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093).
.... manufacturedProduct 1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... performer 0..*Performer2The clinician who is expected to perform the supply could be identified using supply/performer.
... author 0..1AuthorParticipationThe author in a supply represents the clinician who is requesting or planning the supply.
... Slices for participant 0..*Participant2This participant represents a device that is ordered, requested or intended for the patient.
Slice: Unordered, Open by profile:participantRole
.... participant:productInstance C0..1Participant21098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
..... participantRole 1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship represents the insurance coverage the patient may have for the supply.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the supply.
..... typeCode 1..1csFixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the supply.
..... typeCode 1..1csFixed Value: RSON
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned supply.
..... typeCode 1..1csFixed Value: SUBJ
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:plannedCoverage 0..*EntryRelationship
..... typeCode 1..1csFixed Value: COMP
..... act 1..1PlannedCoverageBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Supply.moodCoderequiredPlanned moodCode (SubstanceAdministration/Supply)

Constraints

IdGradePath(s)DetailsRequirements
1098-32092errorSupply.productIf the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093).
:
1098-32096errorSupply.participant:productInstanceIf the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
:
1098-32325warningSupply.productSHOULD contain zero or one [0..1] product (CONF:1098-32325).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.43
..... @extension 1..1stRequired Pattern: 2014-06-09
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... effectiveTime 0..1The effectiveTime in a planned supply represents the time that the supply should occur.
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... repeatNumber 0..1IVL_INTIn a Planned Supply, repeatNumber indicates the number of times the supply event can occur. For example, if a medication is filled at a pharmacy and the prescription may be refilled 3 more times, the supply RepeatNumber equals 4.
... quantity 0..1PQ
... product C0..1InfrastructureRootA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
1098-32325: SHOULD contain zero or one [0..1] product (CONF:1098-32325).
1098-32092: If the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093).
.... manufacturedProduct 1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... performer 0..*Performer2The clinician who is expected to perform the supply could be identified using supply/performer.
... author 0..1AuthorParticipationThe author in a supply represents the clinician who is requesting or planning the supply.
... Slices for participant 0..*Participant2This participant represents a device that is ordered, requested or intended for the patient.
Slice: Unordered, Open by profile:participantRole
.... participant:productInstance C0..1Participant21098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
..... participantRole 1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship represents the insurance coverage the patient may have for the supply.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the supply.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the supply.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned supply.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:plannedCoverage 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... act 1..1PlannedCoverageBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredPlanned moodCode (SubstanceAdministration/Supply)
Supply.statusCoderequiredActStatus
Supply.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Supply.entryRelationship:indication.typeCoderequiredFixed Value: RSON
Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
Supply.entryRelationship:plannedCoverage.typeCoderequiredFixed Value: COMP

Constraints

IdGradePath(s)DetailsRequirements
1098-32092errorSupply.productIf the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093).
:
1098-32096errorSupply.participant:productInstanceIf the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
:
1098-32325warningSupply.productSHOULD contain zero or one [0..1] product (CONF:1098-32325).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... realmCode 0..*CS
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.43
..... @extension 1..1stRequired Pattern: 2014-06-09
... id 1..*II
... code 0..1CDBinding: v3 Code System ActCode (extensible)
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: active
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1The effectiveTime in a planned supply represents the time that the supply should occur.
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..*CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INTIn a Planned Supply, repeatNumber indicates the number of times the supply event can occur. For example, if a medication is filled at a pharmacy and the prescription may be refilled 3 more times, the supply RepeatNumber equals 4.
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product C0..1InfrastructureRootA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
1098-32325: SHOULD contain zero or one [0..1] product (CONF:1098-32325).
1098-32092: If the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093).
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2The clinician who is expected to perform the supply could be identified using supply/performer.
... author 0..1AuthorParticipationThe author in a supply represents the clinician who is requesting or planning the supply.
... informant 0..*Informant
... Slices for participant 0..*Participant2This participant represents a device that is ordered, requested or intended for the patient.
Slice: Unordered, Open by profile:participantRole
.... participant:productInstance C0..1Participant21098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 0..1csBinding: ParticipationType (required)
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship represents the insurance coverage the patient may have for the supply.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the supply.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1PriorityPreferenceBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the supply.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1IndicationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:instruction 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned supply.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1InstructionBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:plannedCoverage 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1PlannedCoverageBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredPlanned moodCode (SubstanceAdministration/Supply)
Supply.templateId:primary.nullFlavorrequiredNullFlavor
Supply.codeextensibleActCode
Supply.statusCoderequiredActStatus
Supply.statusCode.nullFlavorrequiredNullFlavor
Supply.priorityCodeextensibleActPriority
Supply.product.nullFlavorrequiredNullFlavor
Supply.product.typeCoderequiredFixed Value: PRD
Supply.participant:productInstance.nullFlavorrequiredNullFlavor
Supply.participant:productInstance.typeCoderequiredParticipationType
Supply.participant:productInstance.contextControlCoderequiredFixed Value: OP
Supply.entryRelationship:priorityPreference.nullFlavorrequiredNullFlavor
Supply.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Supply.entryRelationship:indication.nullFlavorrequiredNullFlavor
Supply.entryRelationship:indication.typeCoderequiredFixed Value: RSON
Supply.entryRelationship:instruction.nullFlavorrequiredNullFlavor
Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
Supply.entryRelationship:plannedCoverage.nullFlavorrequiredNullFlavor
Supply.entryRelationship:plannedCoverage.typeCoderequiredFixed Value: COMP

Constraints

IdGradePath(s)DetailsRequirements
1098-32092errorSupply.productIf the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093).
:
1098-32096errorSupply.participant:productInstanceIf the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
:
1098-32325warningSupply.productSHOULD contain zero or one [0..1] product (CONF:1098-32325).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2Supply

Summary

Mandatory: 7 elements (4 nested mandatory elements)
Fixed Value: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Supply.templateId is sliced based on the values of value:root, value:extension
  • The element Supply.participant is sliced based on the value of profile:participantRole
  • The element Supply.entryRelationship is sliced based on the values of profile:act, profile:observation

Differential View

This structure is derived from CDAR2Supply

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply CDAR2SupplyXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
... classCode 1..1cs
... moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.43
..... extension 1..1stRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1csFixed Value: active
... effectiveTime 0..1SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TSThe effectiveTime in a planned supply represents the time that the supply should occur.
... repeatNumber 0..1IVL_INTIn a Planned Supply, repeatNumber indicates the number of times the supply event can occur. For example, if a medication is filled at a pharmacy and the prescription may be refilled 3 more times, the supply RepeatNumber equals 4.
... quantity 0..1PQ
... product C0..1InfrastructureRootA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
1098-32325: SHOULD contain zero or one [0..1] product (CONF:1098-32325).
1098-32092: If the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093).
.... manufacturedProduct 1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... performer 0..*Performer2The clinician who is expected to perform the supply could be identified using supply/performer.
... author 0..1AuthorParticipationThe author in a supply represents the clinician who is requesting or planning the supply.
... Slices for participant 0..*Participant2This participant represents a device that is ordered, requested or intended for the patient.
Slice: Unordered, Open by profile:participantRole
.... participant:productInstance C0..1Participant21098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
..... participantRole 1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship represents the insurance coverage the patient may have for the supply.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the supply.
..... typeCode 1..1csFixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the supply.
..... typeCode 1..1csFixed Value: RSON
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned supply.
..... typeCode 1..1csFixed Value: SUBJ
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:plannedCoverage 0..*EntryRelationship
..... typeCode 1..1csFixed Value: COMP
..... act 1..1PlannedCoverageBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Supply.moodCoderequiredPlanned moodCode (SubstanceAdministration/Supply)

Constraints

IdGradePath(s)DetailsRequirements
1098-32092errorSupply.productIf the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093).
:
1098-32096errorSupply.participant:productInstanceIf the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
:
1098-32325warningSupply.productSHOULD contain zero or one [0..1] product (CONF:1098-32325).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.43
..... @extension 1..1stRequired Pattern: 2014-06-09
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... effectiveTime 0..1The effectiveTime in a planned supply represents the time that the supply should occur.
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... repeatNumber 0..1IVL_INTIn a Planned Supply, repeatNumber indicates the number of times the supply event can occur. For example, if a medication is filled at a pharmacy and the prescription may be refilled 3 more times, the supply RepeatNumber equals 4.
... quantity 0..1PQ
... product C0..1InfrastructureRootA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
1098-32325: SHOULD contain zero or one [0..1] product (CONF:1098-32325).
1098-32092: If the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093).
.... manufacturedProduct 1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... performer 0..*Performer2The clinician who is expected to perform the supply could be identified using supply/performer.
... author 0..1AuthorParticipationThe author in a supply represents the clinician who is requesting or planning the supply.
... Slices for participant 0..*Participant2This participant represents a device that is ordered, requested or intended for the patient.
Slice: Unordered, Open by profile:participantRole
.... participant:productInstance C0..1Participant21098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
..... participantRole 1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship represents the insurance coverage the patient may have for the supply.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the supply.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the supply.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned supply.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:plannedCoverage 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... act 1..1PlannedCoverageBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredPlanned moodCode (SubstanceAdministration/Supply)
Supply.statusCoderequiredActStatus
Supply.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Supply.entryRelationship:indication.typeCoderequiredFixed Value: RSON
Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
Supply.entryRelationship:plannedCoverage.typeCoderequiredFixed Value: COMP

Constraints

IdGradePath(s)DetailsRequirements
1098-32092errorSupply.productIf the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093).
:
1098-32096errorSupply.participant:productInstanceIf the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
:
1098-32325warningSupply.productSHOULD contain zero or one [0..1] product (CONF:1098-32325).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... realmCode 0..*CS
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.43
..... @extension 1..1stRequired Pattern: 2014-06-09
... id 1..*II
... code 0..1CDBinding: v3 Code System ActCode (extensible)
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: active
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1The effectiveTime in a planned supply represents the time that the supply should occur.
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..*CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INTIn a Planned Supply, repeatNumber indicates the number of times the supply event can occur. For example, if a medication is filled at a pharmacy and the prescription may be refilled 3 more times, the supply RepeatNumber equals 4.
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product C0..1InfrastructureRootA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
1098-32325: SHOULD contain zero or one [0..1] product (CONF:1098-32325).
1098-32092: If the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093).
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2The clinician who is expected to perform the supply could be identified using supply/performer.
... author 0..1AuthorParticipationThe author in a supply represents the clinician who is requesting or planning the supply.
... informant 0..*Informant
... Slices for participant 0..*Participant2This participant represents a device that is ordered, requested or intended for the patient.
Slice: Unordered, Open by profile:participantRole
.... participant:productInstance C0..1Participant21098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 0..1csBinding: ParticipationType (required)
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship represents the insurance coverage the patient may have for the supply.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*EntryRelationshipThe following entryRelationship represents the priority that a patient or a provider places on the supply.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1PriorityPreferenceBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:indication 0..*EntryRelationshipThe following entryRelationship represents the indication for the supply.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1IndicationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:instruction 0..*EntryRelationshipThe following entryRelationship captures any instructions associated with the planned supply.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1InstructionBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:plannedCoverage 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: COMP
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1PlannedCoverageBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredPlanned moodCode (SubstanceAdministration/Supply)
Supply.templateId:primary.nullFlavorrequiredNullFlavor
Supply.codeextensibleActCode
Supply.statusCoderequiredActStatus
Supply.statusCode.nullFlavorrequiredNullFlavor
Supply.priorityCodeextensibleActPriority
Supply.product.nullFlavorrequiredNullFlavor
Supply.product.typeCoderequiredFixed Value: PRD
Supply.participant:productInstance.nullFlavorrequiredNullFlavor
Supply.participant:productInstance.typeCoderequiredParticipationType
Supply.participant:productInstance.contextControlCoderequiredFixed Value: OP
Supply.entryRelationship:priorityPreference.nullFlavorrequiredNullFlavor
Supply.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
Supply.entryRelationship:indication.nullFlavorrequiredNullFlavor
Supply.entryRelationship:indication.typeCoderequiredFixed Value: RSON
Supply.entryRelationship:instruction.nullFlavorrequiredNullFlavor
Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
Supply.entryRelationship:plannedCoverage.nullFlavorrequiredNullFlavor
Supply.entryRelationship:plannedCoverage.typeCoderequiredFixed Value: COMP

Constraints

IdGradePath(s)DetailsRequirements
1098-32092errorSupply.productIf the product is Medication Information (2.16.840.1.113883.10.20.22.4.23.2) or Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) then the participant **SHALL NOT** be Product Instance (CONF:1098-32092 and CONF:1098-32093).
:
1098-32096errorSupply.participant:productInstanceIf the participant is Product Instance then the product **SHALL NOT** be Medication Information (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
:
1098-32325warningSupply.productSHOULD contain zero or one [0..1] product (CONF:1098-32325).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2Supply

Summary

Mandatory: 7 elements (4 nested mandatory elements)
Fixed Value: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Supply.templateId is sliced based on the values of value:root, value:extension
  • The element Supply.participant is sliced based on the value of profile:participantRole
  • The element Supply.entryRelationship is sliced based on the values of profile:act, profile:observation

 

Other representations of profile: CSV, Excel