Consolidated CDA
3.0.0-ballot - ballot
Consolidated CDA
3.0.0-ballot - ballot
This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MedicationSupplyOrder | Version: 3.0.0-ballot | |||
| Draft as of 2023-12-21 | Computable Name: MedicationSupplyOrder | |||
| Other Identifiers: id: 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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Supply
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Supply | C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain 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 | |
| id | 1..* | II | ||
| text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
 reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode | 1..1 | CS | ||
| @code | 1..1 | cs | 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 | Base for all types and resources | |
| author | 0..1 | Author | ||
 entryRelationship | 0..1 | EntryRelationship | ||
| @typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| act | 1..1 | Instruction | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Supply.statusCode.code | required | ActStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 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('#') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Supply | C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain 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 | Binding: ActClassSupply (required) Fixed Value: SPLY | |
| @moodCode | 1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) Fixed Value: INT | |
| id | 1..* | II | ||
| text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Binding: ActStatus (required) | |
| 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 | ||
| 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 | C | 1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources |
| author | 0..1 | Author | ||
| entryRelationship | 0..1 | EntryRelationship | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| act | C | 1..1 | Instruction | Base for all types and resources |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Supply.classCode | required | Fixed Value: SPLY |
| Supply.moodCode | required | Fixed Value: INT |
| Supply.statusCode | required | ActStatus |
| Supply.statusCode.code | required | ActStatus |
| Supply.entryRelationship.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| product-choice | error | Supply.product.manufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| 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() | |
| should-text-ref-value | warning | Supply.entryRelationship.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Path | Conformance | ValueSet / Code |
| Supply.nullFlavor | required | CDANullFlavor |
| Supply.typeId.nullFlavor | required | CDANullFlavor |
| Supply.templateId:med-supplyOrder.nullFlavor | required | CDANullFlavor |
| Supply.classCode | required | Fixed Value: SPLY |
| Supply.moodCode | required | Fixed Value: INT |
| Supply.code | example | ActCode |
| Supply.text.nullFlavor | required | CDANullFlavor |
| Supply.text.compression | required | CDACompressionAlgorithm |
| Supply.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
| Supply.text.mediaType | example | MediaType |
| Supply.text.representation | required | BinaryDataEncoding |
| Supply.statusCode | required | ActStatus |
| Supply.statusCode.nullFlavor | required | CDANullFlavor |
| Supply.statusCode.code | required | ActStatus |
| Supply.effectiveTime:when.nullFlavor | required | CDANullFlavor |
| Supply.effectiveTime:when.operator | required | SetOperator |
| Supply.priorityCode | example | ActPriority |
| Supply.product.nullFlavor | required | CDANullFlavor |
| Supply.product.typeId.nullFlavor | required | CDANullFlavor |
| Supply.product.typeCode | required | Fixed Value: PRD |
| Supply.entryRelationship.nullFlavor | required | CDANullFlavor |
| Supply.entryRelationship.typeId.nullFlavor | required | CDANullFlavor |
| Supply.entryRelationship.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| product-choice | error | Supply.product.manufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| 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() | |
| should-text-ref-value | warning | Supply.entryRelationship.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Supply
Summary
Mandatory: 7 elements (3 nested mandatory elements)
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Supply
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Supply | C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain 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 | |
| id | 1..* | II | ||
| text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode | 1..1 | CS | ||
| @code | 1..1 | cs | 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 | Base for all types and resources | |
| author | 0..1 | Author | ||
| entryRelationship | 0..1 | EntryRelationship | ||
| @typeCode | 1..1 | cs | Fixed Value: SUBJ | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| act | 1..1 | Instruction | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Supply.statusCode.code | required | ActStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Supply | C | 1..1 | Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value should-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain 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 | Binding: ActClassSupply (required) Fixed Value: SPLY | |
| @moodCode | 1..1 | cs | Binding: XDocumentSubstanceMood (2.0.0) (required) Fixed Value: INT | |
| id | 1..* | II | ||
| text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Binding: ActStatus (required) | |
| 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 | ||
| 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 | C | 1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources |
| author | 0..1 | Author | ||
| entryRelationship | 0..1 | EntryRelationship | ||
| @typeCode | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
| @inversionInd | 1..1 | bl | Fixed Value: true | |
| act | C | 1..1 | Instruction | Base for all types and resources |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Supply.classCode | required | Fixed Value: SPLY |
| Supply.moodCode | required | Fixed Value: INT |
| Supply.statusCode | required | ActStatus |
| Supply.statusCode.code | required | ActStatus |
| Supply.entryRelationship.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| product-choice | error | Supply.product.manufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| 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() | |
| should-text-ref-value | warning | Supply.entryRelationship.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Snapshot View
| Path | Conformance | ValueSet / Code |
| Supply.nullFlavor | required | CDANullFlavor |
| Supply.typeId.nullFlavor | required | CDANullFlavor |
| Supply.templateId:med-supplyOrder.nullFlavor | required | CDANullFlavor |
| Supply.classCode | required | Fixed Value: SPLY |
| Supply.moodCode | required | Fixed Value: INT |
| Supply.code | example | ActCode |
| Supply.text.nullFlavor | required | CDANullFlavor |
| Supply.text.compression | required | CDACompressionAlgorithm |
| Supply.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
| Supply.text.mediaType | example | MediaType |
| Supply.text.representation | required | BinaryDataEncoding |
| Supply.statusCode | required | ActStatus |
| Supply.statusCode.nullFlavor | required | CDANullFlavor |
| Supply.statusCode.code | required | ActStatus |
| Supply.effectiveTime:when.nullFlavor | required | CDANullFlavor |
| Supply.effectiveTime:when.operator | required | SetOperator |
| Supply.priorityCode | example | ActPriority |
| Supply.product.nullFlavor | required | CDANullFlavor |
| Supply.product.typeId.nullFlavor | required | CDANullFlavor |
| Supply.product.typeCode | required | Fixed Value: PRD |
| Supply.entryRelationship.nullFlavor | required | CDANullFlavor |
| Supply.entryRelationship.typeId.nullFlavor | required | CDANullFlavor |
| Supply.entryRelationship.typeCode | required | Fixed Value: SUBJ |
| Id | Grade | Path(s) | Details | Requirements |
| product-choice | error | Supply.product.manufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| 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() | |
| should-text-ref-value | warning | Supply.entryRelationship.act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Supply.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Supply
Summary
Mandatory: 7 elements (3 nested mandatory elements)
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0-ballot based on FHIR 5.0.0. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change