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

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: Medication Supply Order

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MedicationSupplyOrder Version: 4.0.0
Draft as of 2025-10-02 Computable Name: MedicationSupplyOrder
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.17:2014-06-09

This template records the intent to supply a patient with medications.

Templates Used

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

Optional EntryRelationships: InstructionObservation

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 3.0.0:

  • New Content

    • 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
    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-repeatNumber, should-quantity
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:med-supplyOrder 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.17
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs
    ... @moodCode 1..1 cs Fixed Value: INT
    ... 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
    .... @nullFlavor 0..0
    .... @code 1..1 cs Binding: ActStatus (required)
    ... Slices for effectiveTime 0..* SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS Slice: Unordered, Open by exists:high
    .... effectiveTime:when 0..1 IVL_TS
    ..... high 1..1 IVXB_TS
    ... repeatNumber 0..1 IVL_INT In "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
    ... quantity 0..1 PQ
    ... product 0..1 InfrastructureRoot
    .... manufacturedProduct 1..1 MedicationInformation, ImmunizationMedicationInformation
    ... author 0..1 Author
    ... entryRelationship 0..1 EntryRelationship
    .... @typeCode 1..1 cs Fixed Value: SUBJ
    .... @inversionInd 1..1 bl Fixed Value: true
    .... observation 1..1 InstructionObservation

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Supply.statusCode.code Base required ActStatus 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    should-quantity warning Supply SHOULD contain quantity quantity.exists()
    should-repeatNumber warning Supply SHOULD contain repeatNumber repeatNumber.exists()
    should-text-ref-value warning Supply SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Supply.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Supply C 1..1 Supply XML Namespace: urn:hl7-org:v3
    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-repeatNumber, should-quantity
    ... @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:med-supplyOrder 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.17
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs Binding: ActClassSupply (required)
    Fixed Value: SPLY
    ... @moodCode 1..1 cs Binding: XDocumentSubstanceMood (2.0.0) (required)
    Fixed Value: INT
    ... 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)
    .... @code 1..1 cs Binding: ActStatus (required)
    .... @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)
    ... Slices for effectiveTime 0..* Slice: Unordered, Open by exists:high
    .... effectiveTime SXCM_TS
    .... effectiveTime IVL_TS
    .... effectiveTime EIVL_TS
    .... effectiveTime PIVL_TS
    .... effectiveTime SXPR_TS
    .... effectiveTime:when 0..1 IVL_TS
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @value 0..1 ts Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
    ..... @operator 0..1 cs Binding: CDASetOperator (required)
    ..... low 0..1 IVXB_TS
    ..... center 0..1 TS
    ..... width 0..1 PQ
    ..... high 1..1 IVXB_TS
    ... priorityCode 0..* CE Binding: ActPriority (example)
    ... repeatNumber 0..1 IVL_INT In "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
    ... independentInd 0..1 BL
    ... quantity 0..1 PQ
    ... expectedUseTime 0..1 IVL_TS
    ... product 0..1 InfrastructureRoot
    .... @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
    ... author 0..1 Author
    ... informant 0..* Informant
    ... participant 0..* Participant2
    ... entryRelationship 0..1 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: SUBJ
    .... @inversionInd 1..1 bl Fixed Value: true
    .... @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
    ... 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

    Path Status Usage ValueSet Version Source
    Supply.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.templateId:med-supplyOrder.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.classCode Base required ActClassSupply 📦3.0.0 THO v6.5
    Supply.moodCode Base required x_DocumentSubstanceMood 📍2.0.0 THO v5.2
    Supply.code Base example v3 Code System ActCode 📦3.0.0 THO v6.5
    Supply.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Supply.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Supply.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Supply.statusCode.code Base required ActStatus 📦3.0.0 THO v6.5
    Supply.effectiveTime:when.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.effectiveTime:when.​operator Base required CDASetOperator 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Supply.product.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.product.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.product.typeCode Base required ParticipationTargetDirect 📦3.0.0 THO v6.5
    Supply.entryRelationship.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.entryRelationship.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.entryRelationship.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Supply.typeId, Supply.product.typeId, Supply.entryRelationship.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-quantity warning Supply SHOULD contain quantity quantity.exists()
    should-repeatNumber warning Supply SHOULD contain repeatNumber repeatNumber.exists()
    should-text-ref-value warning Supply SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Supply.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Supply C 1..1 Supply XML Namespace: urn:hl7-org:v3
    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-repeatNumber, should-quantity
    ... @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:med-supplyOrder 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.17
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs Binding: ActClassSupply (required)
    Fixed Value: SPLY
    ... @moodCode 1..1 cs Binding: XDocumentSubstanceMood (2.0.0) (required)
    Fixed Value: INT
    ... 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)
    .... @code 1..1 cs Binding: ActStatus (required)
    .... @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)
    ... Slices for effectiveTime 0..* Slice: Unordered, Open by exists:high
    .... effectiveTime SXCM_TS
    .... effectiveTime IVL_TS
    .... effectiveTime EIVL_TS
    .... effectiveTime PIVL_TS
    .... effectiveTime SXPR_TS
    .... effectiveTime:when 0..1 IVL_TS
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @value 0..1 ts Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
    ..... @operator 0..1 cs Binding: CDASetOperator (required)
    ..... low 0..1 IVXB_TS
    ..... center 0..1 TS
    ..... width 0..1 PQ
    ..... high 1..1 IVXB_TS
    ... priorityCode 0..* CE Binding: ActPriority (example)
    ... repeatNumber 0..1 IVL_INT In "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
    ... independentInd 0..1 BL
    ... quantity 0..1 PQ
    ... expectedUseTime 0..1 IVL_TS
    ... product 0..1 InfrastructureRoot
    .... @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
    ... author 0..1 Author
    ... informant 0..* Informant
    ... participant 0..* Participant2
    ... entryRelationship 0..1 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: SUBJ
    .... @inversionInd 1..1 bl Fixed Value: true
    .... @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
    ... 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

    Path Status Usage ValueSet Version Source
    Supply.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.templateId:med-supplyOrder.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.classCode Base required ActClassSupply 📦3.0.0 THO v6.5
    Supply.moodCode Base required x_DocumentSubstanceMood 📍2.0.0 THO v5.2
    Supply.code Base example v3 Code System ActCode 📦3.0.0 THO v6.5
    Supply.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Supply.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Supply.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Supply.statusCode.code Base required ActStatus 📦3.0.0 THO v6.5
    Supply.effectiveTime:when.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.effectiveTime:when.​operator Base required CDASetOperator 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Supply.product.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.product.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.product.typeCode Base required ParticipationTargetDirect 📦3.0.0 THO v6.5
    Supply.entryRelationship.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.entryRelationship.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.entryRelationship.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Supply.typeId, Supply.product.typeId, Supply.entryRelationship.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-quantity warning Supply SHOULD contain quantity quantity.exists()
    should-repeatNumber warning Supply SHOULD contain repeatNumber repeatNumber.exists()
    should-text-ref-value warning Supply SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Supply.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    This structure is derived from Supply

    Summary

    Mandatory: 7 elements(3 nested mandatory elements)
    Fixed: 3 elements
    Prohibited: 1 element

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 2 is sliced based on the values of Supply.templateId
    • The element 1 is sliced based on the value of Supply.effectiveTime

    Differential View

    This structure is derived from Supply

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Supply C 1..1 Supply XML Namespace: urn:hl7-org:v3
    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-repeatNumber, should-quantity
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:med-supplyOrder 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.17
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs
    ... @moodCode 1..1 cs Fixed Value: INT
    ... 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
    .... @nullFlavor 0..0
    .... @code 1..1 cs Binding: ActStatus (required)
    ... Slices for effectiveTime 0..* SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS Slice: Unordered, Open by exists:high
    .... effectiveTime:when 0..1 IVL_TS
    ..... high 1..1 IVXB_TS
    ... repeatNumber 0..1 IVL_INT In "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
    ... quantity 0..1 PQ
    ... product 0..1 InfrastructureRoot
    .... manufacturedProduct 1..1 MedicationInformation, ImmunizationMedicationInformation
    ... author 0..1 Author
    ... entryRelationship 0..1 EntryRelationship
    .... @typeCode 1..1 cs Fixed Value: SUBJ
    .... @inversionInd 1..1 bl Fixed Value: true
    .... observation 1..1 InstructionObservation

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Supply.statusCode.code Base required ActStatus 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    should-quantity warning Supply SHOULD contain quantity quantity.exists()
    should-repeatNumber warning Supply SHOULD contain repeatNumber repeatNumber.exists()
    should-text-ref-value warning Supply SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Supply.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Supply C 1..1 Supply XML Namespace: urn:hl7-org:v3
    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-repeatNumber, should-quantity
    ... @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:med-supplyOrder 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.17
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs Binding: ActClassSupply (required)
    Fixed Value: SPLY
    ... @moodCode 1..1 cs Binding: XDocumentSubstanceMood (2.0.0) (required)
    Fixed Value: INT
    ... 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)
    .... @code 1..1 cs Binding: ActStatus (required)
    .... @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)
    ... Slices for effectiveTime 0..* Slice: Unordered, Open by exists:high
    .... effectiveTime SXCM_TS
    .... effectiveTime IVL_TS
    .... effectiveTime EIVL_TS
    .... effectiveTime PIVL_TS
    .... effectiveTime SXPR_TS
    .... effectiveTime:when 0..1 IVL_TS
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @value 0..1 ts Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
    ..... @operator 0..1 cs Binding: CDASetOperator (required)
    ..... low 0..1 IVXB_TS
    ..... center 0..1 TS
    ..... width 0..1 PQ
    ..... high 1..1 IVXB_TS
    ... priorityCode 0..* CE Binding: ActPriority (example)
    ... repeatNumber 0..1 IVL_INT In "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
    ... independentInd 0..1 BL
    ... quantity 0..1 PQ
    ... expectedUseTime 0..1 IVL_TS
    ... product 0..1 InfrastructureRoot
    .... @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
    ... author 0..1 Author
    ... informant 0..* Informant
    ... participant 0..* Participant2
    ... entryRelationship 0..1 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: SUBJ
    .... @inversionInd 1..1 bl Fixed Value: true
    .... @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
    ... 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

    Path Status Usage ValueSet Version Source
    Supply.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.templateId:med-supplyOrder.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.classCode Base required ActClassSupply 📦3.0.0 THO v6.5
    Supply.moodCode Base required x_DocumentSubstanceMood 📍2.0.0 THO v5.2
    Supply.code Base example v3 Code System ActCode 📦3.0.0 THO v6.5
    Supply.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Supply.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Supply.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Supply.statusCode.code Base required ActStatus 📦3.0.0 THO v6.5
    Supply.effectiveTime:when.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.effectiveTime:when.​operator Base required CDASetOperator 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Supply.product.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.product.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.product.typeCode Base required ParticipationTargetDirect 📦3.0.0 THO v6.5
    Supply.entryRelationship.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.entryRelationship.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.entryRelationship.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Supply.typeId, Supply.product.typeId, Supply.entryRelationship.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-quantity warning Supply SHOULD contain quantity quantity.exists()
    should-repeatNumber warning Supply SHOULD contain repeatNumber repeatNumber.exists()
    should-text-ref-value warning Supply SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Supply.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Supply C 1..1 Supply XML Namespace: urn:hl7-org:v3
    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-repeatNumber, should-quantity
    ... @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:med-supplyOrder 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.17
    ..... @extension 1..1 st Required Pattern: 2014-06-09
    ... @classCode 1..1 cs Binding: ActClassSupply (required)
    Fixed Value: SPLY
    ... @moodCode 1..1 cs Binding: XDocumentSubstanceMood (2.0.0) (required)
    Fixed Value: INT
    ... 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)
    .... @code 1..1 cs Binding: ActStatus (required)
    .... @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)
    ... Slices for effectiveTime 0..* Slice: Unordered, Open by exists:high
    .... effectiveTime SXCM_TS
    .... effectiveTime IVL_TS
    .... effectiveTime EIVL_TS
    .... effectiveTime PIVL_TS
    .... effectiveTime SXPR_TS
    .... effectiveTime:when 0..1 IVL_TS
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @value 0..1 ts Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
    ..... @operator 0..1 cs Binding: CDASetOperator (required)
    ..... low 0..1 IVXB_TS
    ..... center 0..1 TS
    ..... width 0..1 PQ
    ..... high 1..1 IVXB_TS
    ... priorityCode 0..* CE Binding: ActPriority (example)
    ... repeatNumber 0..1 IVL_INT In "INT" (intent) mood, the repeatNumber defines the number of allowed supplies. For example, a repeatNumber of "3" means that the substance can be supplied up to 3 times.
    ... independentInd 0..1 BL
    ... quantity 0..1 PQ
    ... expectedUseTime 0..1 IVL_TS
    ... product 0..1 InfrastructureRoot
    .... @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
    ... author 0..1 Author
    ... informant 0..* Informant
    ... participant 0..* Participant2
    ... entryRelationship 0..1 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: SUBJ
    .... @inversionInd 1..1 bl Fixed Value: true
    .... @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
    ... 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

    Path Status Usage ValueSet Version Source
    Supply.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.templateId:med-supplyOrder.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.classCode Base required ActClassSupply 📦3.0.0 THO v6.5
    Supply.moodCode Base required x_DocumentSubstanceMood 📍2.0.0 THO v5.2
    Supply.code Base example v3 Code System ActCode 📦3.0.0 THO v6.5
    Supply.text.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.text.compression Base required CDACompressionAlgorithm 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.text.integrityCheckAlgorithm Base required IntegrityCheckAlgorithm 📍2.0.0 THO v5.2
    Supply.text.mediaType Base example MediaType 📦3.0.0 THO v6.5
    Supply.text.representation Base required CDABinaryDataEncoding 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.statusCode Base required ActStatus 📦3.0.0 THO v6.5
    Supply.statusCode.code Base required ActStatus 📦3.0.0 THO v6.5
    Supply.effectiveTime:when.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.effectiveTime:when.​operator Base required CDASetOperator 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.priorityCode Base example ActPriority 📦3.0.0 THO v6.5
    Supply.product.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.product.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.product.typeCode Base required ParticipationTargetDirect 📦3.0.0 THO v6.5
    Supply.entryRelationship.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.entryRelationship.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Supply.entryRelationship.​typeCode Base required x_ActRelationshipEntryRelationship 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    II-1 error Supply.typeId, Supply.product.typeId, Supply.entryRelationship.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    should-quantity warning Supply SHOULD contain quantity quantity.exists()
    should-repeatNumber warning Supply SHOULD contain repeatNumber repeatNumber.exists()
    should-text-ref-value warning Supply SHOULD contain text/reference/@value text.reference.value.exists()
    value-starts-octothorpe error Supply.text.reference If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative value.exists() implies value.startsWith('#')

    This structure is derived from Supply

    Summary

    Mandatory: 7 elements(3 nested mandatory elements)
    Fixed: 3 elements
    Prohibited: 1 element

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 2 is sliced based on the values of Supply.templateId
    • The element 1 is sliced based on the value of Supply.effectiveTime

     

    Other representations of profile: CSV, Excel