Consolidated CDA (C-CDA)
3.0.0 - STU3
Consolidated CDA (C-CDA)
3.0.0 - STU3
This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedSupply | Version: 3.0.0 | |||
| Draft as of 2024-05-18 | Computable Name: PlannedSupply | |||
| Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.43:2024-05-01 | ||||
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 effectiveTime 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 Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Supply
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Supply |
C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') should-author: SHOULD contain author |
  Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:planned-supply |
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: 2024-05-01 | |
 @classCode |
1..1 | cs | ||
| @moodCode |
1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply)  (required) | |
| id |
1..* | II | ||
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
 reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| 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 |
0..1 | InfrastructureRoot | Represents either a medication or an immunization supply | |
 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 value:typeCode | |
| participant:productInstance |
0..1 | Participant2 | ||
| @typeCode |
1..1 | cs | Required Pattern: DEV | |
| 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 | URI |
| Supply.moodCode | required | PlannedMoodCodeSubstanceAdministrationSupply http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24 |
| Id | Grade | Path(s) | Details | Requirements |
| shall-product-or-device | error | Supply | The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') : (product | participant.where(typeCode='DEV')).count() = 1 | |
| should-author | warning | Supply | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-text-ref-value | warning | Supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Supply |
C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') should-author: SHOULD contain author |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:planned-supply |
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: 2024-05-01 | |
| @classCode |
1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
| @moodCode |
1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
| id |
1..* | II | ||
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| 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 |
0..1 | InfrastructureRoot | Represents either a medication or an immunization supply | |
| manufacturedProduct |
C | 1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) |
| 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 value:typeCode | |
| participant:productInstance |
0..1 | Participant2 | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Required Pattern: DEV | |
| participantRole |
C | 1..1 | ProductInstance | Base for all types and resources role-choice: playingDevice and playingEntity are mutually exclusive |
| 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 |
C | 1..1 | PriorityPreference | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-author: SHOULD contain author |
| 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 |
C | 1..1 | Indication | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime indication-value: If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. |
| 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 |
C | 1..1 | Instruction | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| entryRelationship:plannedCoverage |
0..* | EntryRelationship | ||
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
| act |
C | 1..1 | PlannedCoverage | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
| Supply.moodCode | required | PlannedMoodCodeSubstanceAdministrationSupply http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24 | |
| Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Supply.participant:productInstance.typeCode | required | Pattern: DEVhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Supply.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Supply.entryRelationship:indication.typeCode | required | Fixed Value: RSONhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Supply.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Supply.entryRelationship:plannedCoverage.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| indication-value | error | Supply.entryRelationship:indication.observation | If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. : value.exists() or (%resource.descendants().ofType(CDA.Observation).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and value.exists())) | |
| product-choice | error | Supply.product.manufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| role-choice | error | Supply.participant:productInstance.participantRole | playingDevice and playingEntity are mutually exclusive : (playingDevice | playingEntity).count() <= 1 | |
| shall-product-or-device | error | Supply | The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') : (product | participant.where(typeCode='DEV')).count() = 1 | |
| should-author | warning | Supply | SHOULD contain author : author.exists() | |
| should-author | warning | Supply.entryRelationship:priorityPreference.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-effectiveTime | warning | Supply.entryRelationship:priorityPreference.observation, Supply.entryRelationship:indication.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-text-ref-value | warning | Supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Supply.entryRelationship:priorityPreference.observation, Supply.entryRelationship:indication.observation, Supply.entryRelationship:instruction.act, Supply.entryRelationship:plannedCoverage.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Supply |
C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') should-author: SHOULD contain author |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:planned-supply |
1..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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: 2024-05-01 | |
| @classCode |
1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
| @moodCode |
1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
| id |
1..* | II | ||
| code |
0..1 | CD | Binding: v3 Code System ActCode (example) | |
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
| @integrityCheck |
0..1 | bin | ||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language |
0..1 | cs | ||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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 (example) | |
| 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 |
0..1 | InfrastructureRoot | Represents either a medication or an immunization supply | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: PRD | |
| manufacturedProduct |
C | 1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) |
| 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 value:typeCode | |
| participant:productInstance |
0..1 | Participant2 | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
 typeId |
0..1 | II | ||
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Required Pattern: DEV | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| 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 |
C | 1..1 | ProductInstance | Base for all types and resources role-choice: playingDevice and playingEntity are mutually exclusive |
| 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: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| 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 |
C | 1..1 | PriorityPreference | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-author: SHOULD contain author |
| 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: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| 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 |
C | 1..1 | Indication | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime indication-value: If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. |
| 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: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| 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 |
C | 1..1 | Instruction | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| 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: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| 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 |
C | 1..1 | PlannedCoverage | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| 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 | ||
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Supply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.templateId:planned-supply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
| Supply.moodCode | required | PlannedMoodCodeSubstanceAdministrationSupply http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24 | |
| Supply.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Supply.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Supply.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Supply.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Supply.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Supply.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Supply.product.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.product.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect | |
| Supply.participant:productInstance.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.participant:productInstance.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.participant:productInstance.typeCode | required | Pattern: DEVhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Supply.participant:productInstance.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
| Supply.entryRelationship:priorityPreference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:priorityPreference.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Supply.entryRelationship:indication.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:indication.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:indication.typeCode | required | Fixed Value: RSONhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Supply.entryRelationship:instruction.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:instruction.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Supply.entryRelationship:plannedCoverage.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:plannedCoverage.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:plannedCoverage.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| indication-value | error | Supply.entryRelationship:indication.observation | If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. : value.exists() or (%resource.descendants().ofType(CDA.Observation).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and value.exists())) | |
| product-choice | error | Supply.product.manufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| role-choice | error | Supply.participant:productInstance.participantRole | playingDevice and playingEntity are mutually exclusive : (playingDevice | playingEntity).count() <= 1 | |
| shall-product-or-device | error | Supply | The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') : (product | participant.where(typeCode='DEV')).count() = 1 | |
| should-author | warning | Supply | SHOULD contain author : author.exists() | |
| should-author | warning | Supply.entryRelationship:priorityPreference.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-effectiveTime | warning | Supply.entryRelationship:priorityPreference.observation, Supply.entryRelationship:indication.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-text-ref-value | warning | Supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Supply.entryRelationship:priorityPreference.observation, Supply.entryRelationship:indication.observation, Supply.entryRelationship:instruction.act, Supply.entryRelationship:plannedCoverage.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Supply
Summary
Mandatory: 7 elements(4 nested mandatory elements)
Fixed: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Supply
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Supply |
C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') should-author: SHOULD contain author |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:planned-supply |
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: 2024-05-01 | |
| @classCode |
1..1 | cs | ||
| @moodCode |
1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
| id |
1..* | II | ||
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| 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 |
0..1 | InfrastructureRoot | Represents either a medication or an immunization supply | |
| 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 value:typeCode | |
| participant:productInstance |
0..1 | Participant2 | ||
| @typeCode |
1..1 | cs | Required Pattern: DEV | |
| 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 | URI |
| Supply.moodCode | required | PlannedMoodCodeSubstanceAdministrationSupply http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24 |
| Id | Grade | Path(s) | Details | Requirements |
| shall-product-or-device | error | Supply | The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') : (product | participant.where(typeCode='DEV')).count() = 1 | |
| should-author | warning | Supply | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-text-ref-value | warning | Supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Supply |
C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') should-author: SHOULD contain author |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:planned-supply |
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: 2024-05-01 | |
| @classCode |
1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
| @moodCode |
1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
| id |
1..* | II | ||
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| 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 |
0..1 | InfrastructureRoot | Represents either a medication or an immunization supply | |
| manufacturedProduct |
C | 1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) |
| 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 value:typeCode | |
| participant:productInstance |
0..1 | Participant2 | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Required Pattern: DEV | |
| participantRole |
C | 1..1 | ProductInstance | Base for all types and resources role-choice: playingDevice and playingEntity are mutually exclusive |
| 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 |
C | 1..1 | PriorityPreference | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-author: SHOULD contain author |
| 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 |
C | 1..1 | Indication | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime indication-value: If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. |
| 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 |
C | 1..1 | Instruction | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| entryRelationship:plannedCoverage |
0..* | EntryRelationship | ||
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
| act |
C | 1..1 | PlannedCoverage | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
| Supply.moodCode | required | PlannedMoodCodeSubstanceAdministrationSupply http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24 | |
| Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Supply.participant:productInstance.typeCode | required | Pattern: DEVhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Supply.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Supply.entryRelationship:indication.typeCode | required | Fixed Value: RSONhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Supply.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Supply.entryRelationship:plannedCoverage.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| indication-value | error | Supply.entryRelationship:indication.observation | If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. : value.exists() or (%resource.descendants().ofType(CDA.Observation).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and value.exists())) | |
| product-choice | error | Supply.product.manufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| role-choice | error | Supply.participant:productInstance.participantRole | playingDevice and playingEntity are mutually exclusive : (playingDevice | playingEntity).count() <= 1 | |
| shall-product-or-device | error | Supply | The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') : (product | participant.where(typeCode='DEV')).count() = 1 | |
| should-author | warning | Supply | SHOULD contain author : author.exists() | |
| should-author | warning | Supply.entryRelationship:priorityPreference.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-effectiveTime | warning | Supply.entryRelationship:priorityPreference.observation, Supply.entryRelationship:indication.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-text-ref-value | warning | Supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Supply.entryRelationship:priorityPreference.observation, Supply.entryRelationship:indication.observation, Supply.entryRelationship:instruction.act, Supply.entryRelationship:plannedCoverage.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Supply |
C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime shall-product-or-device: The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') should-author: SHOULD contain author |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:planned-supply |
1..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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: 2024-05-01 | |
| @classCode |
1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
| @moodCode |
1..1 | cs | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
| id |
1..* | II | ||
| code |
0..1 | CD | Binding: v3 Code System ActCode (example) | |
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
| @integrityCheck |
0..1 | bin | ||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language |
0..1 | cs | ||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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 (example) | |
| 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 |
0..1 | InfrastructureRoot | Represents either a medication or an immunization supply | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: ParticipationTargetDirect (required) Fixed Value: PRD | |
| manufacturedProduct |
C | 1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) |
| 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 value:typeCode | |
| participant:productInstance |
0..1 | Participant2 | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
1..1 | cs | Binding: CDAParticipationType (required) Required Pattern: DEV | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| 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 |
C | 1..1 | ProductInstance | Base for all types and resources role-choice: playingDevice and playingEntity are mutually exclusive |
| 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: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| 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 |
C | 1..1 | PriorityPreference | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-author: SHOULD contain author |
| 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: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| 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 |
C | 1..1 | Indication | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime indication-value: If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. |
| 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: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| 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 |
C | 1..1 | Instruction | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| 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: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| 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 |
C | 1..1 | PlannedCoverage | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value |
| 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 | ||
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Supply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.templateId:planned-supply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.classCode | required | Fixed Value: SPLYhttp://terminology.hl7.org/ValueSet/v3-ActClassSupply | |
| Supply.moodCode | required | PlannedMoodCodeSubstanceAdministrationSupply http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24 | |
| Supply.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Supply.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Supply.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Supply.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Supply.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Supply.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Supply.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Supply.product.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.product.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.product.typeCode | required | Fixed Value: PRDhttp://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect | |
| Supply.participant:productInstance.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.participant:productInstance.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.participant:productInstance.typeCode | required | Pattern: DEVhttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Supply.participant:productInstance.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
| Supply.entryRelationship:priorityPreference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:priorityPreference.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:priorityPreference.typeCode | required | Fixed Value: REFRhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Supply.entryRelationship:indication.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:indication.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:indication.typeCode | required | Fixed Value: RSONhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Supply.entryRelationship:instruction.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:instruction.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:instruction.typeCode | required | Fixed Value: SUBJhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship | |
| Supply.entryRelationship:plannedCoverage.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:plannedCoverage.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Supply.entryRelationship:plannedCoverage.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| indication-value | error | Supply.entryRelationship:indication.observation | If the ID element does not reference a problem recorded elsewhere in the document, then observation/value must be populated with a coded entry. : value.exists() or (%resource.descendants().ofType(CDA.Observation).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and value.exists())) | |
| product-choice | error | Supply.product.manufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| role-choice | error | Supply.participant:productInstance.participantRole | playingDevice and playingEntity are mutually exclusive : (playingDevice | playingEntity).count() <= 1 | |
| shall-product-or-device | error | Supply | The supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV') : (product | participant.where(typeCode='DEV')).count() = 1 | |
| should-author | warning | Supply | SHOULD contain author : author.exists() | |
| should-author | warning | Supply.entryRelationship:priorityPreference.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-effectiveTime | warning | Supply.entryRelationship:priorityPreference.observation, Supply.entryRelationship:indication.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-text-ref-value | warning | Supply | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| should-text-ref-value | warning | Supply.entryRelationship:priorityPreference.observation, Supply.entryRelationship:indication.observation, Supply.entryRelationship:instruction.act, Supply.entryRelationship:plannedCoverage.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Supply
Summary
Mandatory: 7 elements(4 nested mandatory elements)
Fixed: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0 based on FHIR 5.0.0. Generated 2024-05-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change