Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.43 | Version: 2.2 | |||
Active as of 2022-05-13 | Computable Name: PlannedSupply | |||
Other Identifiers: : 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
Summary
Mandatory: 8 elements (10 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from CDAR2Supply
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | 1..1 | CDAR2Supply | ||
classCode | 1..1 | code | Required Pattern: PROC | |
moodCode | 1..1 | code | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.43 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: 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 | I | 0..1 | Element | A product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD). 1098-32092: If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092). |
manufacturedProduct | 1..1 | |||
manufacturedProduct | ManufacturedProduct(MedicationInformation) | |||
manufacturedProduct | ManufacturedProduct(ImmunizationMedicationInformation) | |||
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 | I | 0..1 | Participant2 | 1098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096). |
participantRole | 1..1 | ProductInstance | ||
Slices for entryRelationship | 0..* | Element | 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..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the supply. | |
typeCode | 1..1 | code | Required Pattern: REFR | |
observation | 1..1 | PriorityPreference | ||
entryRelationship:indication | 0..* | Element | The following entryRelationship represents the indication for the supply. | |
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | Indication | ||
entryRelationship:instruction | 0..* | Element | The following entryRelationship captures any instructions associated with the planned supply. | |
typeCode | 1..1 | code | Required Pattern: SUBJ | |
act | 1..1 | Instruction | ||
entryRelationship:plannedCoverage | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: COMP | |
act | 1..1 | PlannedCoverage | ||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | 1..1 | CDAR2Supply | ||
classCode | 1..1 | code | Binding: ActClassSupply (required) Fixed Value: SPLY | |
moodCode | 1..1 | code | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
assigningAuthorityName | 0..1 | string | ||
displayable | 0..1 | boolean | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.43 | |
extension | 1..1 | string | 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 | code | Binding: NullFlavor (required) | |
code | 1..1 | string | Required Pattern: active | |
sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
sdtcValueSetVersion | 0..1 | string | 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 | I | 0..1 | Element | A product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD). 1098-32092: If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092). |
typeCode | 1..1 | code | Binding: ParticipationTargetDirect (required) Fixed Value: PRD | |
manufacturedProduct | 1..1 | |||
manufacturedProduct | ManufacturedProduct(MedicationInformation) | |||
manufacturedProduct | ManufacturedProduct(ImmunizationMedicationInformation) | |||
subject | 0..1 | Element | ||
typeCode | 1..1 | code | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
awarenessCode | 0..1 | CE | Binding: TargetAwareness (extensible) | |
relatedSubject | 1..1 | RelatedSubject | ||
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..* | Element | ||
typeCode | 1..1 | code | Binding: ParticipationInformationGenerator (required) Fixed Value: INF | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
assignedEntity | 0..1 | AssignedEntity | ||
relatedEntity | 0..1 | RelatedEntity | ||
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 | I | 0..1 | Participant2 | 1098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096). |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
typeCode | 0..1 | code | Binding: ParticipationType (required) | |
contextControlCode | 0..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
sdtcFunctionCode | 0..1 | CE | XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ProductInstance | ||
Slices for entryRelationship | I | 0..* | Element | The following entryRelationship represents the insurance coverage the patient may have for the supply. Slice: Unordered, Open by profile:act, profile:observation |
entryRelationship:All Slices | Content/Rules for all slices | |||
typeCode | 1..1 | code | ||
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
(Choice of one) | 1..1 | |||
observation | 0..1 | Observation | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
observationMedia | 0..1 | ObservationMedia | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
procedure | 0..1 | Procedure | ||
encounter | 0..1 | Encounter | ||
organizer | 0..1 | Organizer | ||
act | 0..1 | Act | ||
entryRelationship:priorityPreference | I | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the supply. |
typeCode | 1..1 | code | Required Pattern: REFR | |
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
observation | 1..1 | PriorityPreference | ||
entryRelationship:indication | I | 0..* | Element | The following entryRelationship represents the indication for the supply. |
typeCode | 1..1 | code | Required Pattern: RSON | |
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
observation | 1..1 | Indication | ||
entryRelationship:instruction | I | 0..* | Element | The following entryRelationship captures any instructions associated with the planned supply. |
typeCode | 1..1 | code | Required Pattern: SUBJ | |
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
act | 1..1 | Instruction | ||
entryRelationship:plannedCoverage | I | 0..* | Element | |
typeCode | 1..1 | code | Required Pattern: COMP | |
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
act | 1..1 | PlannedCoverage | ||
reference | 0..* | Element | ||
typeCode | 1..1 | code | ||
seperatableInd | 0..1 | BL | ||
externalAct | 0..1 | ExternalAct | ||
externalObservation | 0..1 | ExternalObservation | ||
externalProcedure | 0..1 | ExternalProcedure | ||
externalDocument | 0..1 | ExternalDocument | ||
precondition | 0..* | Precondition | ||
Documentation for this format |
This structure is derived from CDAR2Supply
Summary
Mandatory: 8 elements (10 nested mandatory 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 | 1..1 | CDAR2Supply | ||
classCode | 1..1 | code | Required Pattern: PROC | |
moodCode | 1..1 | code | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.43 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 1..* | II | ||
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: 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 | I | 0..1 | Element | A product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD). 1098-32092: If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092). |
manufacturedProduct | 1..1 | |||
manufacturedProduct | ManufacturedProduct(MedicationInformation) | |||
manufacturedProduct | ManufacturedProduct(ImmunizationMedicationInformation) | |||
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 | I | 0..1 | Participant2 | 1098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096). |
participantRole | 1..1 | ProductInstance | ||
Slices for entryRelationship | 0..* | Element | 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..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the supply. | |
typeCode | 1..1 | code | Required Pattern: REFR | |
observation | 1..1 | PriorityPreference | ||
entryRelationship:indication | 0..* | Element | The following entryRelationship represents the indication for the supply. | |
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | Indication | ||
entryRelationship:instruction | 0..* | Element | The following entryRelationship captures any instructions associated with the planned supply. | |
typeCode | 1..1 | code | Required Pattern: SUBJ | |
act | 1..1 | Instruction | ||
entryRelationship:plannedCoverage | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: COMP | |
act | 1..1 | PlannedCoverage | ||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Supply | 1..1 | CDAR2Supply | ||
classCode | 1..1 | code | Binding: ActClassSupply (required) Fixed Value: SPLY | |
moodCode | 1..1 | code | Binding: Planned moodCode (SubstanceAdministration/Supply) (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
assigningAuthorityName | 0..1 | string | ||
displayable | 0..1 | boolean | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.43 | |
extension | 1..1 | string | 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 | code | Binding: NullFlavor (required) | |
code | 1..1 | string | Required Pattern: active | |
sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
sdtcValueSetVersion | 0..1 | string | 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 | I | 0..1 | Element | A product is recommended or even required under certain implementations. This IG makes product as recommended (SHOULD). 1098-32092: If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092). |
typeCode | 1..1 | code | Binding: ParticipationTargetDirect (required) Fixed Value: PRD | |
manufacturedProduct | 1..1 | |||
manufacturedProduct | ManufacturedProduct(MedicationInformation) | |||
manufacturedProduct | ManufacturedProduct(ImmunizationMedicationInformation) | |||
subject | 0..1 | Element | ||
typeCode | 1..1 | code | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
awarenessCode | 0..1 | CE | Binding: TargetAwareness (extensible) | |
relatedSubject | 1..1 | RelatedSubject | ||
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..* | Element | ||
typeCode | 1..1 | code | Binding: ParticipationInformationGenerator (required) Fixed Value: INF | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
assignedEntity | 0..1 | AssignedEntity | ||
relatedEntity | 0..1 | RelatedEntity | ||
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 | I | 0..1 | Participant2 | 1098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096). |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
typeCode | 0..1 | code | Binding: ParticipationType (required) | |
contextControlCode | 0..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
sdtcFunctionCode | 0..1 | CE | XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ProductInstance | ||
Slices for entryRelationship | I | 0..* | Element | The following entryRelationship represents the insurance coverage the patient may have for the supply. Slice: Unordered, Open by profile:act, profile:observation |
entryRelationship:All Slices | Content/Rules for all slices | |||
typeCode | 1..1 | code | ||
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
(Choice of one) | 1..1 | |||
observation | 0..1 | Observation | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
observationMedia | 0..1 | ObservationMedia | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
procedure | 0..1 | Procedure | ||
encounter | 0..1 | Encounter | ||
organizer | 0..1 | Organizer | ||
act | 0..1 | Act | ||
entryRelationship:priorityPreference | I | 0..* | Element | The following entryRelationship represents the priority that a patient or a provider places on the supply. |
typeCode | 1..1 | code | Required Pattern: REFR | |
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
observation | 1..1 | PriorityPreference | ||
entryRelationship:indication | I | 0..* | Element | The following entryRelationship represents the indication for the supply. |
typeCode | 1..1 | code | Required Pattern: RSON | |
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
observation | 1..1 | Indication | ||
entryRelationship:instruction | I | 0..* | Element | The following entryRelationship captures any instructions associated with the planned supply. |
typeCode | 1..1 | code | Required Pattern: SUBJ | |
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
act | 1..1 | Instruction | ||
entryRelationship:plannedCoverage | I | 0..* | Element | |
typeCode | 1..1 | code | Required Pattern: COMP | |
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
act | 1..1 | PlannedCoverage | ||
reference | 0..* | Element | ||
typeCode | 1..1 | code | ||
seperatableInd | 0..1 | BL | ||
externalAct | 0..1 | ExternalAct | ||
externalObservation | 0..1 | ExternalObservation | ||
externalProcedure | 0..1 | ExternalProcedure | ||
externalDocument | 0..1 | ExternalDocument | ||
precondition | 0..* | Precondition | ||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
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.typeCode | required | Fixed Value: PRD |
Supply.subject.typeCode | required | Fixed Value: SBJ |
Supply.subject.contextControlCode | required | Fixed Value: OP |
Supply.subject.awarenessCode | extensible | TargetAwareness |
Supply.informant.typeCode | required | Fixed Value: INF |
Supply.informant.contextControlCode | required | Fixed Value: OP |
Supply.participant:productInstance.nullFlavor | required | NullFlavor |
Supply.participant:productInstance.typeCode | required | ParticipationType |
Supply.participant:productInstance.contextControlCode | required | Fixed Value: OP |
Id | Grade | Path | Details | Requirements |
1098-32092 | error | Supply.product | If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092). : | |
1098-32096 | error | Supply.participant:productInstance | If the participant is Product Instance then the product **SHALL NOT** be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096). : | |
sup-er-1 | error | Supply.entryRelationship | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
sup-er-1 | error | Supply.entryRelationship:priorityPreference | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
sup-er-1 | error | Supply.entryRelationship:indication | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
sup-er-1 | error | Supply.entryRelationship:instruction | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
sup-er-1 | error | Supply.entryRelationship:plannedCoverage | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |