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
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2Supply
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | CDAR2Supply | XML 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..1 | cs | ||
moodCode | 1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.43 | |
extension | 1..1 | st | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
statusCode | 1..1 | CS | ||
code | 1..1 | cs | Fixed Value: active | |
effectiveTime | 0..1 | SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | The effectiveTime in a planned supply represents the time that the supply should occur. | |
repeatNumber | 0..1 | IVL_INT | In 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..1 | PQ | ||
product | C | 0..1 | InfrastructureRoot | A 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..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources | |
performer | 0..* | Performer2 | The clinician who is expected to perform the supply could be identified using supply/performer. | |
author | 0..1 | AuthorParticipation | The author in a supply represents the clinician who is requesting or planning the supply. | |
Slices for participant | 0..* | Participant2 | This participant represents a device that is ordered, requested or intended for the patient. Slice: Unordered, Open by profile:participantRole | |
participant:productInstance | C | 0..1 | Participant2 | 1098-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..1 | ProductInstance | Base for all types and resources | |
Slices for entryRelationship | 0..* | EntryRelationship | The following entryRelationship represents the insurance coverage the patient may have for the supply. Slice: Unordered, Open by profile:act, profile:observation | |
entryRelationship:priorityPreference | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the supply. | |
typeCode | 1..1 | cs | Fixed Value: REFR | |
observation | 1..1 | PriorityPreference | Base for all types and resources | |
entryRelationship:indication | 0..* | EntryRelationship | The following entryRelationship represents the indication for the supply. | |
typeCode | 1..1 | cs | Fixed Value: RSON | |
observation | 1..1 | Indication | Base for all types and resources | |
entryRelationship:instruction | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned supply. | |
typeCode | 1..1 | cs | Fixed Value: SUBJ | |
act | 1..1 | Instruction | Base for all types and resources | |
entryRelationship:plannedCoverage | 0..* | EntryRelationship | ||
typeCode | 1..1 | cs | Fixed Value: COMP | |
act | 1..1 | PlannedCoverage | Base for all types and resources | |
Documentation for this format |
Path | Conformance | ValueSet |
Supply.moodCode | required | Planned moodCode (SubstanceAdministration/Supply) |
Id | Grade | Path(s) | Details | Requirements |
1098-32092 | error | Supply.product | 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). : | |
1098-32096 | error | Supply.participant:productInstance | 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). : | |
1098-32325 | warning | Supply.product | SHOULD contain zero or one [0..1] product (CONF:1098-32325). : |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | 1..1 | CDAR2Supply | XML 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..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
@moodCode | 1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.43 | |
@extension | 1..1 | st | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
@code | 1..1 | cs | Fixed Value: active | |
effectiveTime | 0..1 | The effectiveTime in a planned supply represents the time that the supply should occur. | ||
effectiveTime | SXCM_TS | |||
effectiveTime | IVL_TS | |||
effectiveTime | EIVL_TS | |||
effectiveTime | PIVL_TS | |||
effectiveTime | SXPR_TS | |||
repeatNumber | 0..1 | IVL_INT | In 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..1 | PQ | ||
product | C | 0..1 | InfrastructureRoot | A 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..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources | |
performer | 0..* | Performer2 | The clinician who is expected to perform the supply could be identified using supply/performer. | |
author | 0..1 | AuthorParticipation | The author in a supply represents the clinician who is requesting or planning the supply. | |
Slices for participant | 0..* | Participant2 | This participant represents a device that is ordered, requested or intended for the patient. Slice: Unordered, Open by profile:participantRole | |
participant:productInstance | C | 0..1 | Participant2 | 1098-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..1 | ProductInstance | Base for all types and resources | |
Slices for entryRelationship | 0..* | EntryRelationship | The following entryRelationship represents the insurance coverage the patient may have for the supply. Slice: Unordered, Open by profile:act, profile:observation | |
entryRelationship:priorityPreference | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the supply. | |
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
observation | 1..1 | PriorityPreference | Base for all types and resources | |
entryRelationship:indication | 0..* | EntryRelationship | The following entryRelationship represents the indication for the supply. | |
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
observation | 1..1 | Indication | Base for all types and resources | |
entryRelationship:instruction | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned supply. | |
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
act | 1..1 | Instruction | Base for all types and resources | |
entryRelationship:plannedCoverage | 0..* | EntryRelationship | ||
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
act | 1..1 | PlannedCoverage | Base for all types and resources | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.moodCode | required | Planned moodCode (SubstanceAdministration/Supply) |
Supply.statusCode | required | ActStatus |
Supply.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR |
Supply.entryRelationship:indication.typeCode | required | Fixed Value: RSON |
Supply.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ |
Supply.entryRelationship:plannedCoverage.typeCode | required | Fixed Value: COMP |
Id | Grade | Path(s) | Details | Requirements |
1098-32092 | error | Supply.product | 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). : | |
1098-32096 | error | Supply.participant:productInstance | 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). : | |
1098-32325 | warning | Supply.product | SHOULD contain zero or one [0..1] product (CONF:1098-32325). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | 1..1 | CDAR2Supply | XML 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..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
@moodCode | 1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.43 | |
@extension | 1..1 | st | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
code | 0..1 | CD | Binding: v3 Code System ActCode (extensible) | |
text | 0..1 | ED | ||
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 1..1 | cs | Fixed Value: active | |
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
effectiveTime | 0..1 | The effectiveTime in a planned supply represents the time that the supply should occur. | ||
effectiveTime | SXCM_TS | |||
effectiveTime | IVL_TS | |||
effectiveTime | EIVL_TS | |||
effectiveTime | PIVL_TS | |||
effectiveTime | SXPR_TS | |||
priorityCode | 0..* | CE | Binding: ActPriority (extensible) | |
repeatNumber | 0..1 | IVL_INT | In 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..1 | BL | ||
quantity | 0..1 | PQ | ||
expectedUseTime | 0..1 | IVL_TS | ||
product | C | 0..1 | InfrastructureRoot | A 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..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
@typeCode | 0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: PRD | |
manufacturedProduct | 1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources | |
subject | 0..1 | Subject | ||
specimen | 0..* | Specimen | ||
performer | 0..* | Performer2 | The clinician who is expected to perform the supply could be identified using supply/performer. | |
author | 0..1 | AuthorParticipation | The author in a supply represents the clinician who is requesting or planning the supply. | |
informant | 0..* | Informant | ||
Slices for participant | 0..* | Participant2 | This participant represents a device that is ordered, requested or intended for the patient. Slice: Unordered, Open by profile:participantRole | |
participant:productInstance | C | 0..1 | Participant2 | 1098-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..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 0..1 | cs | Binding: ParticipationType (required) | |
@contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ProductInstance | Base for all types and resources | |
Slices for entryRelationship | 0..* | EntryRelationship | The following entryRelationship represents the insurance coverage the patient may have for the supply. Slice: Unordered, Open by profile:act, profile:observation | |
entryRelationship:priorityPreference | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the supply. | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
@inversionInd | 0..1 | bl | ||
@contextConductionInd | 0..1 | bl | ||
@negationInd | 0..1 | bl | ||
sequenceNumber | 0..1 | INT | ||
seperatableInd | 0..1 | BL | ||
act | 0..1 | Act | ||
encounter | 0..1 | Encounter | ||
observation | 1..1 | PriorityPreference | Base for all types and resources | |
observationMedia | 0..1 | ObservationMedia | ||
organizer | 0..1 | Organizer | ||
procedure | 0..1 | Procedure | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
entryRelationship:indication | 0..* | EntryRelationship | The following entryRelationship represents the indication for the supply. | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
@inversionInd | 0..1 | bl | ||
@contextConductionInd | 0..1 | bl | ||
@negationInd | 0..1 | bl | ||
sequenceNumber | 0..1 | INT | ||
seperatableInd | 0..1 | BL | ||
act | 0..1 | Act | ||
encounter | 0..1 | Encounter | ||
observation | 1..1 | Indication | Base for all types and resources | |
observationMedia | 0..1 | ObservationMedia | ||
organizer | 0..1 | Organizer | ||
procedure | 0..1 | Procedure | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
entryRelationship:instruction | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned supply. | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
@inversionInd | 0..1 | bl | ||
@contextConductionInd | 0..1 | bl | ||
@negationInd | 0..1 | bl | ||
sequenceNumber | 0..1 | INT | ||
seperatableInd | 0..1 | BL | ||
act | 1..1 | Instruction | Base for all types and resources | |
encounter | 0..1 | Encounter | ||
observation | 0..1 | Observation | ||
observationMedia | 0..1 | ObservationMedia | ||
organizer | 0..1 | Organizer | ||
procedure | 0..1 | Procedure | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
entryRelationship:plannedCoverage | 0..* | EntryRelationship | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
@inversionInd | 0..1 | bl | ||
@contextConductionInd | 0..1 | bl | ||
@negationInd | 0..1 | bl | ||
sequenceNumber | 0..1 | INT | ||
seperatableInd | 0..1 | BL | ||
act | 1..1 | PlannedCoverage | Base for all types and resources | |
encounter | 0..1 | Encounter | ||
observation | 0..1 | Observation | ||
observationMedia | 0..1 | ObservationMedia | ||
organizer | 0..1 | Organizer | ||
procedure | 0..1 | Procedure | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
reference | 0..* | Reference | ||
precondition | 0..* | Precondition | ||
Documentation for this format |
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.moodCode | required | Planned moodCode (SubstanceAdministration/Supply) |
Supply.templateId:primary.nullFlavor | required | NullFlavor |
Supply.code | extensible | ActCode |
Supply.statusCode | required | ActStatus |
Supply.statusCode.nullFlavor | required | NullFlavor |
Supply.priorityCode | extensible | ActPriority |
Supply.product.nullFlavor | required | NullFlavor |
Supply.product.typeCode | required | Fixed Value: PRD |
Supply.participant:productInstance.nullFlavor | required | NullFlavor |
Supply.participant:productInstance.typeCode | required | ParticipationType |
Supply.participant:productInstance.contextControlCode | required | Fixed Value: OP |
Supply.entryRelationship:priorityPreference.nullFlavor | required | NullFlavor |
Supply.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR |
Supply.entryRelationship:indication.nullFlavor | required | NullFlavor |
Supply.entryRelationship:indication.typeCode | required | Fixed Value: RSON |
Supply.entryRelationship:instruction.nullFlavor | required | NullFlavor |
Supply.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ |
Supply.entryRelationship:plannedCoverage.nullFlavor | required | NullFlavor |
Supply.entryRelationship:plannedCoverage.typeCode | required | Fixed Value: COMP |
Id | Grade | Path(s) | Details | Requirements |
1098-32092 | error | Supply.product | 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). : | |
1098-32096 | error | Supply.participant:productInstance | 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). : | |
1098-32325 | warning | Supply.product | SHOULD contain zero or one [0..1] product (CONF:1098-32325). : | |
ele-1 | error | **ALL** elements | All 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:
Differential View
This structure is derived from CDAR2Supply
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | CDAR2Supply | XML 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..1 | cs | ||
moodCode | 1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.43 | |
extension | 1..1 | st | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
statusCode | 1..1 | CS | ||
code | 1..1 | cs | Fixed Value: active | |
effectiveTime | 0..1 | SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | The effectiveTime in a planned supply represents the time that the supply should occur. | |
repeatNumber | 0..1 | IVL_INT | In 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..1 | PQ | ||
product | C | 0..1 | InfrastructureRoot | A 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..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources | |
performer | 0..* | Performer2 | The clinician who is expected to perform the supply could be identified using supply/performer. | |
author | 0..1 | AuthorParticipation | The author in a supply represents the clinician who is requesting or planning the supply. | |
Slices for participant | 0..* | Participant2 | This participant represents a device that is ordered, requested or intended for the patient. Slice: Unordered, Open by profile:participantRole | |
participant:productInstance | C | 0..1 | Participant2 | 1098-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..1 | ProductInstance | Base for all types and resources | |
Slices for entryRelationship | 0..* | EntryRelationship | The following entryRelationship represents the insurance coverage the patient may have for the supply. Slice: Unordered, Open by profile:act, profile:observation | |
entryRelationship:priorityPreference | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the supply. | |
typeCode | 1..1 | cs | Fixed Value: REFR | |
observation | 1..1 | PriorityPreference | Base for all types and resources | |
entryRelationship:indication | 0..* | EntryRelationship | The following entryRelationship represents the indication for the supply. | |
typeCode | 1..1 | cs | Fixed Value: RSON | |
observation | 1..1 | Indication | Base for all types and resources | |
entryRelationship:instruction | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned supply. | |
typeCode | 1..1 | cs | Fixed Value: SUBJ | |
act | 1..1 | Instruction | Base for all types and resources | |
entryRelationship:plannedCoverage | 0..* | EntryRelationship | ||
typeCode | 1..1 | cs | Fixed Value: COMP | |
act | 1..1 | PlannedCoverage | Base for all types and resources | |
Documentation for this format |
Path | Conformance | ValueSet |
Supply.moodCode | required | Planned moodCode (SubstanceAdministration/Supply) |
Id | Grade | Path(s) | Details | Requirements |
1098-32092 | error | Supply.product | 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). : | |
1098-32096 | error | Supply.participant:productInstance | 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). : | |
1098-32325 | warning | Supply.product | SHOULD contain zero or one [0..1] product (CONF:1098-32325). : |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | 1..1 | CDAR2Supply | XML 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..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
@moodCode | 1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.43 | |
@extension | 1..1 | st | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
@code | 1..1 | cs | Fixed Value: active | |
effectiveTime | 0..1 | The effectiveTime in a planned supply represents the time that the supply should occur. | ||
effectiveTime | SXCM_TS | |||
effectiveTime | IVL_TS | |||
effectiveTime | EIVL_TS | |||
effectiveTime | PIVL_TS | |||
effectiveTime | SXPR_TS | |||
repeatNumber | 0..1 | IVL_INT | In 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..1 | PQ | ||
product | C | 0..1 | InfrastructureRoot | A 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..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources | |
performer | 0..* | Performer2 | The clinician who is expected to perform the supply could be identified using supply/performer. | |
author | 0..1 | AuthorParticipation | The author in a supply represents the clinician who is requesting or planning the supply. | |
Slices for participant | 0..* | Participant2 | This participant represents a device that is ordered, requested or intended for the patient. Slice: Unordered, Open by profile:participantRole | |
participant:productInstance | C | 0..1 | Participant2 | 1098-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..1 | ProductInstance | Base for all types and resources | |
Slices for entryRelationship | 0..* | EntryRelationship | The following entryRelationship represents the insurance coverage the patient may have for the supply. Slice: Unordered, Open by profile:act, profile:observation | |
entryRelationship:priorityPreference | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the supply. | |
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
observation | 1..1 | PriorityPreference | Base for all types and resources | |
entryRelationship:indication | 0..* | EntryRelationship | The following entryRelationship represents the indication for the supply. | |
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
observation | 1..1 | Indication | Base for all types and resources | |
entryRelationship:instruction | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned supply. | |
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
act | 1..1 | Instruction | Base for all types and resources | |
entryRelationship:plannedCoverage | 0..* | EntryRelationship | ||
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
act | 1..1 | PlannedCoverage | Base for all types and resources | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.moodCode | required | Planned moodCode (SubstanceAdministration/Supply) |
Supply.statusCode | required | ActStatus |
Supply.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR |
Supply.entryRelationship:indication.typeCode | required | Fixed Value: RSON |
Supply.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ |
Supply.entryRelationship:plannedCoverage.typeCode | required | Fixed Value: COMP |
Id | Grade | Path(s) | Details | Requirements |
1098-32092 | error | Supply.product | 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). : | |
1098-32096 | error | Supply.participant:productInstance | 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). : | |
1098-32325 | warning | Supply.product | SHOULD contain zero or one [0..1] product (CONF:1098-32325). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | 1..1 | CDAR2Supply | XML 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..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
@moodCode | 1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.43 | |
@extension | 1..1 | st | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
code | 0..1 | CD | Binding: v3 Code System ActCode (extensible) | |
text | 0..1 | ED | ||
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
@code | 1..1 | cs | Fixed Value: active | |
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
effectiveTime | 0..1 | The effectiveTime in a planned supply represents the time that the supply should occur. | ||
effectiveTime | SXCM_TS | |||
effectiveTime | IVL_TS | |||
effectiveTime | EIVL_TS | |||
effectiveTime | PIVL_TS | |||
effectiveTime | SXPR_TS | |||
priorityCode | 0..* | CE | Binding: ActPriority (extensible) | |
repeatNumber | 0..1 | IVL_INT | In 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..1 | BL | ||
quantity | 0..1 | PQ | ||
expectedUseTime | 0..1 | IVL_TS | ||
product | C | 0..1 | InfrastructureRoot | A 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..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
@typeCode | 0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: PRD | |
manufacturedProduct | 1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources | |
subject | 0..1 | Subject | ||
specimen | 0..* | Specimen | ||
performer | 0..* | Performer2 | The clinician who is expected to perform the supply could be identified using supply/performer. | |
author | 0..1 | AuthorParticipation | The author in a supply represents the clinician who is requesting or planning the supply. | |
informant | 0..* | Informant | ||
Slices for participant | 0..* | Participant2 | This participant represents a device that is ordered, requested or intended for the patient. Slice: Unordered, Open by profile:participantRole | |
participant:productInstance | C | 0..1 | Participant2 | 1098-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..1 | cs | Binding: NullFlavor (required) | |
@typeCode | 0..1 | cs | Binding: ParticipationType (required) | |
@contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ProductInstance | Base for all types and resources | |
Slices for entryRelationship | 0..* | EntryRelationship | The following entryRelationship represents the insurance coverage the patient may have for the supply. Slice: Unordered, Open by profile:act, profile:observation | |
entryRelationship:priorityPreference | 0..* | EntryRelationship | The following entryRelationship represents the priority that a patient or a provider places on the supply. | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: REFR | |
@inversionInd | 0..1 | bl | ||
@contextConductionInd | 0..1 | bl | ||
@negationInd | 0..1 | bl | ||
sequenceNumber | 0..1 | INT | ||
seperatableInd | 0..1 | BL | ||
act | 0..1 | Act | ||
encounter | 0..1 | Encounter | ||
observation | 1..1 | PriorityPreference | Base for all types and resources | |
observationMedia | 0..1 | ObservationMedia | ||
organizer | 0..1 | Organizer | ||
procedure | 0..1 | Procedure | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
entryRelationship:indication | 0..* | EntryRelationship | The following entryRelationship represents the indication for the supply. | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: RSON | |
@inversionInd | 0..1 | bl | ||
@contextConductionInd | 0..1 | bl | ||
@negationInd | 0..1 | bl | ||
sequenceNumber | 0..1 | INT | ||
seperatableInd | 0..1 | BL | ||
act | 0..1 | Act | ||
encounter | 0..1 | Encounter | ||
observation | 1..1 | Indication | Base for all types and resources | |
observationMedia | 0..1 | ObservationMedia | ||
organizer | 0..1 | Organizer | ||
procedure | 0..1 | Procedure | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
entryRelationship:instruction | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned supply. | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
@inversionInd | 0..1 | bl | ||
@contextConductionInd | 0..1 | bl | ||
@negationInd | 0..1 | bl | ||
sequenceNumber | 0..1 | INT | ||
seperatableInd | 0..1 | BL | ||
act | 1..1 | Instruction | Base for all types and resources | |
encounter | 0..1 | Encounter | ||
observation | 0..1 | Observation | ||
observationMedia | 0..1 | ObservationMedia | ||
organizer | 0..1 | Organizer | ||
procedure | 0..1 | Procedure | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
entryRelationship:plannedCoverage | 0..* | EntryRelationship | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
@typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
@inversionInd | 0..1 | bl | ||
@contextConductionInd | 0..1 | bl | ||
@negationInd | 0..1 | bl | ||
sequenceNumber | 0..1 | INT | ||
seperatableInd | 0..1 | BL | ||
act | 1..1 | PlannedCoverage | Base for all types and resources | |
encounter | 0..1 | Encounter | ||
observation | 0..1 | Observation | ||
observationMedia | 0..1 | ObservationMedia | ||
organizer | 0..1 | Organizer | ||
procedure | 0..1 | Procedure | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
reference | 0..* | Reference | ||
precondition | 0..* | Precondition | ||
Documentation for this format |
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.moodCode | required | Planned moodCode (SubstanceAdministration/Supply) |
Supply.templateId:primary.nullFlavor | required | NullFlavor |
Supply.code | extensible | ActCode |
Supply.statusCode | required | ActStatus |
Supply.statusCode.nullFlavor | required | NullFlavor |
Supply.priorityCode | extensible | ActPriority |
Supply.product.nullFlavor | required | NullFlavor |
Supply.product.typeCode | required | Fixed Value: PRD |
Supply.participant:productInstance.nullFlavor | required | NullFlavor |
Supply.participant:productInstance.typeCode | required | ParticipationType |
Supply.participant:productInstance.contextControlCode | required | Fixed Value: OP |
Supply.entryRelationship:priorityPreference.nullFlavor | required | NullFlavor |
Supply.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFR |
Supply.entryRelationship:indication.nullFlavor | required | NullFlavor |
Supply.entryRelationship:indication.typeCode | required | Fixed Value: RSON |
Supply.entryRelationship:instruction.nullFlavor | required | NullFlavor |
Supply.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJ |
Supply.entryRelationship:plannedCoverage.nullFlavor | required | NullFlavor |
Supply.entryRelationship:plannedCoverage.typeCode | required | Fixed Value: COMP |
Id | Grade | Path(s) | Details | Requirements |
1098-32092 | error | Supply.product | 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). : | |
1098-32096 | error | Supply.participant:productInstance | 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). : | |
1098-32325 | warning | Supply.product | SHOULD contain zero or one [0..1] product (CONF:1098-32325). : | |
ele-1 | error | **ALL** elements | All 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: