Consolidated CDA (C-CDA)
4.0.0 - STU4 United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v4.0.0: CCDA 4.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: Planned Supply

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PlannedSupply Version: 4.0.0
Draft as of 2025-06-20 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).

Templates Used

Although open templates may contain any valid CDA content, the following templates are specifically called out by this template:

Optional EntryRelationships: Indication, InstructionObservation, PlannedCoverage, PriorityPreference

Usages:

Changes since version 3.0.0:

  • The resource metadata has changed (description)

    • Formal Views of Template Content

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

    This structure is derived from Supply

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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)
    Constraints: should-text-ref-value, should-effectiveTime, shall-product-or-device, should-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)
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    ... 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
    ... 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
    ... 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
    .... entryRelationship:indication 0..* EntryRelationship The following entryRelationship represents the indication for the supply.
    ..... @typeCode 1..1 cs Fixed Value: RSON
    ..... observation 1..1 Indication
    .... entryRelationship:instruction 0..* EntryRelationship The following entryRelationship captures any instructions associated with the planned supply.
    ..... @typeCode 1..1 cs Fixed Value: SUBJ
    ..... observation 1..1 InstructionObservation
    .... entryRelationship:plannedCoverage 0..* EntryRelationship
    ..... @typeCode 1..1 cs Fixed Value: COMP
    ..... act 1..1 PlannedCoverage

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Supply.moodCoderequiredPlannedMoodCodeSubstanceAdministrationSupply .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24

    Constraints

    IdGradePath(s)DetailsRequirements
    shall-product-or-deviceerrorSupplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
    : (product | participant.where(typeCode='DEV')).count() = 1
    should-authorwarningSupplySHOULD contain author
    : author.exists()
    should-effectiveTimewarningSupplySHOULD contain effectiveTime
    : effectiveTime.exists()
    should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
    : text.reference.value.exists()
    value-starts-octothorpeerrorSupply.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
    : value.exists() implies value.startsWith('#')
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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)
    Constraints: should-text-ref-value, should-effectiveTime, shall-product-or-device, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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 Constraints: value-starts-octothorpe
    .... 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 C 0..1 II Constraints: II-1
    ..... @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 1..1 MedicationInformation, ImmunizationMedicationInformation
    ... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 ProductInstance
    ... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 PriorityPreference
    ..... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 Indication
    ..... 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 C 0..1 II Constraints: II-1
    ...... @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 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 InstructionObservation
    ..... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 PlannedCoverage
    ..... 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)

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Supply.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.templateId:planned-supply.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.classCoderequiredFixed Value: SPLY
    http://terminology.hl7.org/ValueSet/v3-ActClassSupply
    Supply.moodCoderequiredPlannedMoodCodeSubstanceAdministrationSupply .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24
    Supply.codeexampleActCode
    http://terminology.hl7.org/ValueSet/v3-ActCode
    Supply.text.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.text.compressionrequiredCDACompressionAlgorithm
    http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
    Supply.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
    http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
    Supply.text.mediaTypeexampleMediaType
    http://terminology.hl7.org/ValueSet/v3-MediaType
    Supply.text.representationrequiredBinaryDataEncoding
    http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
    Supply.statusCoderequiredActStatus
    http://terminology.hl7.org/ValueSet/v3-ActStatus
    Supply.statusCode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.priorityCodeexampleActPriority
    http://terminology.hl7.org/ValueSet/v3-ActPriority
    Supply.product.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.product.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.product.typeCoderequiredFixed Value: PRD
    http://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect
    Supply.participant:productInstance.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.participant:productInstance.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.participant:productInstance.typeCoderequiredPattern Value: DEV
    http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
    Supply.participant:productInstance.contextControlCoderequiredFixed Value: OP
    http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
    Supply.entryRelationship:priorityPreference.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:priorityPreference.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    Supply.entryRelationship:indication.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:indication.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:indication.typeCoderequiredFixed Value: RSON
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    Supply.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    Supply.entryRelationship:plannedCoverage.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:plannedCoverage.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:plannedCoverage.typeCoderequiredFixed Value: COMP
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorSupply.typeId, Supply.product.typeId, Supply.participant:productInstance.typeId, Supply.entryRelationship:priorityPreference.typeId, Supply.entryRelationship:indication.typeId, Supply.entryRelationship:instruction.typeId, Supply.entryRelationship:plannedCoverage.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    shall-product-or-deviceerrorSupplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
    : (product | participant.where(typeCode='DEV')).count() = 1
    should-authorwarningSupplySHOULD contain author
    : author.exists()
    should-effectiveTimewarningSupplySHOULD contain effectiveTime
    : effectiveTime.exists()
    should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
    : text.reference.value.exists()
    value-starts-octothorpeerrorSupply.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
    : value.exists() implies value.startsWith('#')
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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)
    Constraints: should-text-ref-value, should-effectiveTime, shall-product-or-device, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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 Constraints: value-starts-octothorpe
    .... 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 C 0..1 II Constraints: II-1
    ..... @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 1..1 MedicationInformation, ImmunizationMedicationInformation
    ... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 ProductInstance
    ... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 PriorityPreference
    ..... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 Indication
    ..... 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 C 0..1 II Constraints: II-1
    ...... @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 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 InstructionObservation
    ..... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 PlannedCoverage
    ..... 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)

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Supply.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.templateId:planned-supply.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.classCoderequiredFixed Value: SPLY
    http://terminology.hl7.org/ValueSet/v3-ActClassSupply
    Supply.moodCoderequiredPlannedMoodCodeSubstanceAdministrationSupply .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24
    Supply.codeexampleActCode
    http://terminology.hl7.org/ValueSet/v3-ActCode
    Supply.text.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.text.compressionrequiredCDACompressionAlgorithm
    http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
    Supply.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
    http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
    Supply.text.mediaTypeexampleMediaType
    http://terminology.hl7.org/ValueSet/v3-MediaType
    Supply.text.representationrequiredBinaryDataEncoding
    http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
    Supply.statusCoderequiredActStatus
    http://terminology.hl7.org/ValueSet/v3-ActStatus
    Supply.statusCode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.priorityCodeexampleActPriority
    http://terminology.hl7.org/ValueSet/v3-ActPriority
    Supply.product.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.product.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.product.typeCoderequiredFixed Value: PRD
    http://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect
    Supply.participant:productInstance.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.participant:productInstance.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.participant:productInstance.typeCoderequiredPattern Value: DEV
    http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
    Supply.participant:productInstance.contextControlCoderequiredFixed Value: OP
    http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
    Supply.entryRelationship:priorityPreference.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:priorityPreference.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    Supply.entryRelationship:indication.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:indication.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:indication.typeCoderequiredFixed Value: RSON
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    Supply.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    Supply.entryRelationship:plannedCoverage.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:plannedCoverage.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:plannedCoverage.typeCoderequiredFixed Value: COMP
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorSupply.typeId, Supply.product.typeId, Supply.participant:productInstance.typeId, Supply.entryRelationship:priorityPreference.typeId, Supply.entryRelationship:indication.typeId, Supply.entryRelationship:instruction.typeId, Supply.entryRelationship:plannedCoverage.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    shall-product-or-deviceerrorSupplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
    : (product | participant.where(typeCode='DEV')).count() = 1
    should-authorwarningSupplySHOULD contain author
    : author.exists()
    should-effectiveTimewarningSupplySHOULD contain effectiveTime
    : effectiveTime.exists()
    should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
    : text.reference.value.exists()
    value-starts-octothorpeerrorSupply.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
    : value.exists() implies value.startsWith('#')

    Differential View

    This structure is derived from Supply

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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)
    Constraints: should-text-ref-value, should-effectiveTime, shall-product-or-device, should-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)
    ... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
    .... reference C 0..1 TEL Constraints: value-starts-octothorpe
    ... 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
    ... 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
    ... 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
    .... entryRelationship:indication 0..* EntryRelationship The following entryRelationship represents the indication for the supply.
    ..... @typeCode 1..1 cs Fixed Value: RSON
    ..... observation 1..1 Indication
    .... entryRelationship:instruction 0..* EntryRelationship The following entryRelationship captures any instructions associated with the planned supply.
    ..... @typeCode 1..1 cs Fixed Value: SUBJ
    ..... observation 1..1 InstructionObservation
    .... entryRelationship:plannedCoverage 0..* EntryRelationship
    ..... @typeCode 1..1 cs Fixed Value: COMP
    ..... act 1..1 PlannedCoverage

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Supply.moodCoderequiredPlannedMoodCodeSubstanceAdministrationSupply .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24

    Constraints

    IdGradePath(s)DetailsRequirements
    shall-product-or-deviceerrorSupplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
    : (product | participant.where(typeCode='DEV')).count() = 1
    should-authorwarningSupplySHOULD contain author
    : author.exists()
    should-effectiveTimewarningSupplySHOULD contain effectiveTime
    : effectiveTime.exists()
    should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
    : text.reference.value.exists()
    value-starts-octothorpeerrorSupply.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
    : value.exists() implies value.startsWith('#')

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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)
    Constraints: should-text-ref-value, should-effectiveTime, shall-product-or-device, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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 Constraints: value-starts-octothorpe
    .... 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 C 0..1 II Constraints: II-1
    ..... @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 1..1 MedicationInformation, ImmunizationMedicationInformation
    ... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 ProductInstance
    ... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 PriorityPreference
    ..... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 Indication
    ..... 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 C 0..1 II Constraints: II-1
    ...... @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 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 InstructionObservation
    ..... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 PlannedCoverage
    ..... 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)

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Supply.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.templateId:planned-supply.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.classCoderequiredFixed Value: SPLY
    http://terminology.hl7.org/ValueSet/v3-ActClassSupply
    Supply.moodCoderequiredPlannedMoodCodeSubstanceAdministrationSupply .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24
    Supply.codeexampleActCode
    http://terminology.hl7.org/ValueSet/v3-ActCode
    Supply.text.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.text.compressionrequiredCDACompressionAlgorithm
    http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
    Supply.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
    http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
    Supply.text.mediaTypeexampleMediaType
    http://terminology.hl7.org/ValueSet/v3-MediaType
    Supply.text.representationrequiredBinaryDataEncoding
    http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
    Supply.statusCoderequiredActStatus
    http://terminology.hl7.org/ValueSet/v3-ActStatus
    Supply.statusCode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.priorityCodeexampleActPriority
    http://terminology.hl7.org/ValueSet/v3-ActPriority
    Supply.product.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.product.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.product.typeCoderequiredFixed Value: PRD
    http://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect
    Supply.participant:productInstance.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.participant:productInstance.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.participant:productInstance.typeCoderequiredPattern Value: DEV
    http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
    Supply.participant:productInstance.contextControlCoderequiredFixed Value: OP
    http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
    Supply.entryRelationship:priorityPreference.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:priorityPreference.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    Supply.entryRelationship:indication.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:indication.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:indication.typeCoderequiredFixed Value: RSON
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    Supply.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    Supply.entryRelationship:plannedCoverage.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:plannedCoverage.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:plannedCoverage.typeCoderequiredFixed Value: COMP
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorSupply.typeId, Supply.product.typeId, Supply.participant:productInstance.typeId, Supply.entryRelationship:priorityPreference.typeId, Supply.entryRelationship:indication.typeId, Supply.entryRelationship:instruction.typeId, Supply.entryRelationship:plannedCoverage.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    shall-product-or-deviceerrorSupplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
    : (product | participant.where(typeCode='DEV')).count() = 1
    should-authorwarningSupplySHOULD contain author
    : author.exists()
    should-effectiveTimewarningSupplySHOULD contain effectiveTime
    : effectiveTime.exists()
    should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
    : text.reference.value.exists()
    value-starts-octothorpeerrorSupply.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
    : value.exists() implies value.startsWith('#')

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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)
    Constraints: should-text-ref-value, should-effectiveTime, shall-product-or-device, should-author
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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 Constraints: value-starts-octothorpe
    .... 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 C 0..1 II Constraints: II-1
    ..... @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 1..1 MedicationInformation, ImmunizationMedicationInformation
    ... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 ProductInstance
    ... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 PriorityPreference
    ..... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 Indication
    ..... 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 C 0..1 II Constraints: II-1
    ...... @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 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 1..1 InstructionObservation
    ..... 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 C 0..1 II Constraints: II-1
    ...... @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 1..1 PlannedCoverage
    ..... 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)

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Supply.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.templateId:planned-supply.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.classCoderequiredFixed Value: SPLY
    http://terminology.hl7.org/ValueSet/v3-ActClassSupply
    Supply.moodCoderequiredPlannedMoodCodeSubstanceAdministrationSupply .
    http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.24
    Supply.codeexampleActCode
    http://terminology.hl7.org/ValueSet/v3-ActCode
    Supply.text.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.text.compressionrequiredCDACompressionAlgorithm
    http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
    Supply.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
    http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
    Supply.text.mediaTypeexampleMediaType
    http://terminology.hl7.org/ValueSet/v3-MediaType
    Supply.text.representationrequiredBinaryDataEncoding
    http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
    Supply.statusCoderequiredActStatus
    http://terminology.hl7.org/ValueSet/v3-ActStatus
    Supply.statusCode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.priorityCodeexampleActPriority
    http://terminology.hl7.org/ValueSet/v3-ActPriority
    Supply.product.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.product.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.product.typeCoderequiredFixed Value: PRD
    http://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect
    Supply.participant:productInstance.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.participant:productInstance.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.participant:productInstance.typeCoderequiredPattern Value: DEV
    http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
    Supply.participant:productInstance.contextControlCoderequiredFixed Value: OP
    http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
    Supply.entryRelationship:priorityPreference.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:priorityPreference.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:priorityPreference.typeCoderequiredFixed Value: REFR
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    Supply.entryRelationship:indication.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:indication.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:indication.typeCoderequiredFixed Value: RSON
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    Supply.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship
    Supply.entryRelationship:plannedCoverage.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:plannedCoverage.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Supply.entryRelationship:plannedCoverage.typeCoderequiredFixed Value: COMP
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorSupply.typeId, Supply.product.typeId, Supply.participant:productInstance.typeId, Supply.entryRelationship:priorityPreference.typeId, Supply.entryRelationship:indication.typeId, Supply.entryRelationship:instruction.typeId, Supply.entryRelationship:plannedCoverage.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    shall-product-or-deviceerrorSupplyThe supply SHALL contain either 1 product or 1 device participant (@typeCode='DEV')
    : (product | participant.where(typeCode='DEV')).count() = 1
    should-authorwarningSupplySHOULD contain author
    : author.exists()
    should-effectiveTimewarningSupplySHOULD contain effectiveTime
    : effectiveTime.exists()
    should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
    : text.reference.value.exists()
    value-starts-octothorpeerrorSupply.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
    : value.exists() implies value.startsWith('#')

     

    Other representations of profile: CSV, Excel