Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: Planned Supply

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.43 Version: 2.1.0-draft1
Active as of 2023-01-16 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 1..1CDAR2SupplyBase for all types and resources
... classCode 1..1codeRequired Pattern: PROC
... moodCode 1..1codeBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.43
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1stringRequired Pattern: 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..1ElementA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
1098-32092: If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092).
.... manufacturedProduct 1..1
..... manufacturedProductManufacturedProduct(MedicationInformation)
..... manufacturedProductManufacturedProduct(ImmunizationMedicationInformation)
... 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 (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (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..*ElementThe following entryRelationship represents the insurance coverage the patient may have for the supply.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*ElementThe following entryRelationship represents the priority that a patient or a provider places on the supply.
..... typeCode 1..1codeRequired Pattern: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*ElementThe following entryRelationship represents the indication for the supply.
..... typeCode 1..1codeRequired Pattern: RSON
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*ElementThe following entryRelationship captures any instructions associated with the planned supply.
..... typeCode 1..1codeRequired Pattern: SUBJ
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:plannedCoverage 0..*Element
..... typeCode 1..1codeRequired Pattern: 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 (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092).
:
1098-32096errorSupply.participant:productInstanceIf the participant is Product Instance then the product **SHALL NOT** be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyBase for all types and resources
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1codeBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.43
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CSBinding: ActStatus (required)
.... code 1..1stringRequired Pattern: 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..1ElementA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
1098-32092: If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092).
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1
..... manufacturedProductManufacturedProduct(MedicationInformation)
..... manufacturedProductManufacturedProduct(ImmunizationMedicationInformation)
... 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 (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (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 C0..*ElementThe following entryRelationship represents the insurance coverage the patient may have for the supply.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:priorityPreference C0..*ElementThe following entryRelationship represents the priority that a patient or a provider places on the supply.
..... typeCode 1..1codeRequired Pattern: REFR
..... contextConductionInd 1..1boolean
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication C0..*ElementThe following entryRelationship represents the indication for the supply.
..... typeCode 1..1codeRequired Pattern: RSON
..... contextConductionInd 1..1boolean
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction C0..*ElementThe following entryRelationship captures any instructions associated with the planned supply.
..... typeCode 1..1codeRequired Pattern: SUBJ
..... contextConductionInd 1..1boolean
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:plannedCoverage C0..*Element
..... typeCode 1..1codeRequired Pattern: COMP
..... contextConductionInd 1..1boolean
..... 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.product.typeCoderequiredFixed Value: PRD

Constraints

IdGradePath(s)DetailsRequirements
1098-32092errorSupply.productIf the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092).
:
1098-32096errorSupply.participant:productInstanceIf the participant is Product Instance then the product **SHALL NOT** be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
sup-er-1errorSupply.entryRelationship, Supply.entryRelationship:priorityPreference, Supply.entryRelationship:indication, Supply.entryRelationship:instruction, Supply.entryRelationship:plannedCoverageOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyBase for all types and resources
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1codeBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... realmCode 0..*CS
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.43
..... extension 1..1stringRequired 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..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: active
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: 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..1ElementA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
1098-32092: If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092).
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1
..... manufacturedProductManufacturedProduct(MedicationInformation)
..... manufacturedProductManufacturedProduct(ImmunizationMedicationInformation)
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... 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..*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..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... 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 (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... typeCode 0..1codeBinding: ParticipationType (required)
..... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship C0..*ElementThe following entryRelationship represents the insurance coverage the patient may have for the supply.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... 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
.... entryRelationship:priorityPreference C0..*ElementThe following entryRelationship represents the priority that a patient or a provider places on the supply.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: REFR
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication C0..*ElementThe following entryRelationship represents the indication for the supply.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction C0..*ElementThe following entryRelationship captures any instructions associated with the planned supply.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:plannedCoverage C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: COMP
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1PlannedCoverageBase for all types and resources
... reference 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... 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.typeCoderequiredFixed Value: PRD
Supply.subject.typeCoderequiredFixed Value: SBJ
Supply.subject.contextControlCoderequiredFixed Value: OP
Supply.subject.awarenessCodeextensibleTargetAwareness
Supply.informant.typeCoderequiredFixed Value: INF
Supply.informant.contextControlCoderequiredFixed Value: OP
Supply.participant:productInstance.nullFlavorrequiredNullFlavor
Supply.participant:productInstance.typeCoderequiredParticipationType
Supply.participant:productInstance.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
1098-32092errorSupply.productIf the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092).
:
1098-32096errorSupply.participant:productInstanceIf the participant is Product Instance then the product **SHALL NOT** be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sup-er-1errorSupply.entryRelationship, Supply.entryRelationship:priorityPreference, Supply.entryRelationship:indication, Supply.entryRelationship:instruction, Supply.entryRelationship:plannedCoverageOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

Differential View

This structure is derived from CDAR2Supply

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyBase for all types and resources
... classCode 1..1codeRequired Pattern: PROC
... moodCode 1..1codeBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.43
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1stringRequired Pattern: 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..1ElementA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
1098-32092: If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092).
.... manufacturedProduct 1..1
..... manufacturedProductManufacturedProduct(MedicationInformation)
..... manufacturedProductManufacturedProduct(ImmunizationMedicationInformation)
... 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 (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (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..*ElementThe following entryRelationship represents the insurance coverage the patient may have for the supply.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:priorityPreference 0..*ElementThe following entryRelationship represents the priority that a patient or a provider places on the supply.
..... typeCode 1..1codeRequired Pattern: REFR
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication 0..*ElementThe following entryRelationship represents the indication for the supply.
..... typeCode 1..1codeRequired Pattern: RSON
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction 0..*ElementThe following entryRelationship captures any instructions associated with the planned supply.
..... typeCode 1..1codeRequired Pattern: SUBJ
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:plannedCoverage 0..*Element
..... typeCode 1..1codeRequired Pattern: 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 (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092).
:
1098-32096errorSupply.participant:productInstanceIf the participant is Product Instance then the product **SHALL NOT** be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyBase for all types and resources
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1codeBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.43
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CSBinding: ActStatus (required)
.... code 1..1stringRequired Pattern: 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..1ElementA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
1098-32092: If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092).
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1
..... manufacturedProductManufacturedProduct(MedicationInformation)
..... manufacturedProductManufacturedProduct(ImmunizationMedicationInformation)
... 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 (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (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 C0..*ElementThe following entryRelationship represents the insurance coverage the patient may have for the supply.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:priorityPreference C0..*ElementThe following entryRelationship represents the priority that a patient or a provider places on the supply.
..... typeCode 1..1codeRequired Pattern: REFR
..... contextConductionInd 1..1boolean
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication C0..*ElementThe following entryRelationship represents the indication for the supply.
..... typeCode 1..1codeRequired Pattern: RSON
..... contextConductionInd 1..1boolean
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction C0..*ElementThe following entryRelationship captures any instructions associated with the planned supply.
..... typeCode 1..1codeRequired Pattern: SUBJ
..... contextConductionInd 1..1boolean
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:plannedCoverage C0..*Element
..... typeCode 1..1codeRequired Pattern: COMP
..... contextConductionInd 1..1boolean
..... 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.product.typeCoderequiredFixed Value: PRD

Constraints

IdGradePath(s)DetailsRequirements
1098-32092errorSupply.productIf the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092).
:
1098-32096errorSupply.participant:productInstanceIf the participant is Product Instance then the product **SHALL NOT** be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
sup-er-1errorSupply.entryRelationship, Supply.entryRelationship:priorityPreference, Supply.entryRelationship:indication, Supply.entryRelationship:instruction, Supply.entryRelationship:plannedCoverageOnly 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyBase for all types and resources
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1codeBinding: Planned moodCode (SubstanceAdministration/Supply) (required)
... realmCode 0..*CS
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.43
..... extension 1..1stringRequired 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..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: active
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: 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..1ElementA product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD).
1098-32092: If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092).
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1
..... manufacturedProductManufacturedProduct(MedicationInformation)
..... manufacturedProductManufacturedProduct(ImmunizationMedicationInformation)
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... 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..*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..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... 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 (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... typeCode 0..1codeBinding: ParticipationType (required)
..... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship C0..*ElementThe following entryRelationship represents the insurance coverage the patient may have for the supply.
Slice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... 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
.... entryRelationship:priorityPreference C0..*ElementThe following entryRelationship represents the priority that a patient or a provider places on the supply.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: REFR
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1PriorityPreferenceBase for all types and resources
.... entryRelationship:indication C0..*ElementThe following entryRelationship represents the indication for the supply.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1IndicationBase for all types and resources
.... entryRelationship:instruction C0..*ElementThe following entryRelationship captures any instructions associated with the planned supply.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1InstructionBase for all types and resources
.... entryRelationship:plannedCoverage C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: COMP
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1PlannedCoverageBase for all types and resources
... reference 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... 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.typeCoderequiredFixed Value: PRD
Supply.subject.typeCoderequiredFixed Value: SBJ
Supply.subject.contextControlCoderequiredFixed Value: OP
Supply.subject.awarenessCodeextensibleTargetAwareness
Supply.informant.typeCoderequiredFixed Value: INF
Supply.informant.contextControlCoderequiredFixed Value: OP
Supply.participant:productInstance.nullFlavorrequiredNullFlavor
Supply.participant:productInstance.typeCoderequiredParticipationType
Supply.participant:productInstance.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
1098-32092errorSupply.productIf the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092).
:
1098-32096errorSupply.participant:productInstanceIf the participant is Product Instance then the product **SHALL NOT** be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sup-er-1errorSupply.entryRelationship, Supply.entryRelationship:priorityPreference, Supply.entryRelationship:indication, Supply.entryRelationship:instruction, Supply.entryRelationship:plannedCoverageOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

 

​Other representations of profile: CSV, Excel, Schematron