Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MedicationSupplyOrder | Version: 2.1 | |||
Draft as of 2023-09-29 | 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 CDAR2Supply
Path | Conformance | ValueSet |
Supply.statusCode.code | required | ActStatus |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 1..1 | CDAR2Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources | |
![]() ![]() ![]() | 1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
![]() ![]() ![]() | 1..1 | cs | Fixed Value: INT | |
![]() ![]() ![]() | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() | 1..1 | II | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.17 | |
![]() ![]() ![]() ![]() ![]() | 1..1 | st | Required Pattern: 2014-06-09 | |
![]() ![]() ![]() | 1..* | II | ||
![]() ![]() ![]() | 1..1 | CS | Binding: ActStatus (required) | |
![]() ![]() ![]() ![]() | 1..1 | cs | Binding: ActStatus (required) | |
![]() ![]() ![]() | 0..* | Slice: Unordered, Open by value:high | ||
![]() ![]() ![]() ![]() | SXCM_TS | |||
![]() ![]() ![]() ![]() | IVL_TS | |||
![]() ![]() ![]() ![]() | EIVL_TS | |||
![]() ![]() ![]() ![]() | PIVL_TS | |||
![]() ![]() ![]() ![]() | SXPR_TS | |||
![]() ![]() ![]() ![]() | 0..1 | IVL_TS | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | IVXB_TS | ||
![]() ![]() ![]() | 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. | |
![]() ![]() ![]() | 0..1 | PQ | ||
![]() ![]() ![]() | 0..1 | InfrastructureRoot | ||
![]() ![]() ![]() ![]() | 1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources | |
![]() ![]() ![]() | 0..1 | Author | ||
![]() ![]() ![]() | 0..1 | EntryRelationship | ||
![]() ![]() ![]() ![]() | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
![]() ![]() ![]() ![]() | 1..1 | bl | Fixed Value: true | |
![]() ![]() ![]() ![]() | 1..1 | Instruction | Base for all types and resources | |
![]() |
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.statusCode | required | ActStatus |
Supply.statusCode.code | required | ActStatus |
Supply.entryRelationship.typeCode | required | Fixed Value: SUBJ |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.templateId:primary.nullFlavor | required | NullFlavor |
Supply.code | extensible | ActCode |
Supply.statusCode | required | ActStatus |
Supply.statusCode.nullFlavor | required | NullFlavor |
Supply.statusCode.code | required | ActStatus |
Supply.effectiveTime:when.nullFlavor | required | NullFlavor |
Supply.effectiveTime:when.operator | required | SetOperator |
Supply.priorityCode | extensible | ActPriority |
Supply.product.nullFlavor | required | NullFlavor |
Supply.product.typeCode | required | Fixed Value: PRD |
Supply.entryRelationship.nullFlavor | required | NullFlavor |
Supply.entryRelationship.typeCode | required | Fixed Value: SUBJ |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2Supply
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 CDAR2Supply
Path | Conformance | ValueSet |
Supply.statusCode.code | required | ActStatus |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 1..1 | CDAR2Supply | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition Base for all types and resources | |
![]() ![]() ![]() | 1..1 | cs | Binding: ActClassSupply (required) Fixed Value: SPLY | |
![]() ![]() ![]() | 1..1 | cs | Fixed Value: INT | |
![]() ![]() ![]() | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() | 1..1 | II | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.17 | |
![]() ![]() ![]() ![]() ![]() | 1..1 | st | Required Pattern: 2014-06-09 | |
![]() ![]() ![]() | 1..* | II | ||
![]() ![]() ![]() | 1..1 | CS | Binding: ActStatus (required) | |
![]() ![]() ![]() ![]() | 1..1 | cs | Binding: ActStatus (required) | |
![]() ![]() ![]() | 0..* | Slice: Unordered, Open by value:high | ||
![]() ![]() ![]() ![]() | SXCM_TS | |||
![]() ![]() ![]() ![]() | IVL_TS | |||
![]() ![]() ![]() ![]() | EIVL_TS | |||
![]() ![]() ![]() ![]() | PIVL_TS | |||
![]() ![]() ![]() ![]() | SXPR_TS | |||
![]() ![]() ![]() ![]() | 0..1 | IVL_TS | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | IVXB_TS | ||
![]() ![]() ![]() | 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. | |
![]() ![]() ![]() | 0..1 | PQ | ||
![]() ![]() ![]() | 0..1 | InfrastructureRoot | ||
![]() ![]() ![]() ![]() | 1..1 | MedicationInformation, ImmunizationMedicationInformation | Base for all types and resources | |
![]() ![]() ![]() | 0..1 | Author | ||
![]() ![]() ![]() | 0..1 | EntryRelationship | ||
![]() ![]() ![]() ![]() | 1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: SUBJ | |
![]() ![]() ![]() ![]() | 1..1 | bl | Fixed Value: true | |
![]() ![]() ![]() ![]() | 1..1 | Instruction | Base for all types and resources | |
![]() |
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.statusCode | required | ActStatus |
Supply.statusCode.code | required | ActStatus |
Supply.entryRelationship.typeCode | required | Fixed Value: SUBJ |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
Path | Conformance | ValueSet / Code |
Supply.classCode | required | Fixed Value: SPLY |
Supply.templateId:primary.nullFlavor | required | NullFlavor |
Supply.code | extensible | ActCode |
Supply.statusCode | required | ActStatus |
Supply.statusCode.nullFlavor | required | NullFlavor |
Supply.statusCode.code | required | ActStatus |
Supply.effectiveTime:when.nullFlavor | required | NullFlavor |
Supply.effectiveTime:when.operator | required | SetOperator |
Supply.priorityCode | extensible | ActPriority |
Supply.product.nullFlavor | required | NullFlavor |
Supply.product.typeCode | required | Fixed Value: PRD |
Supply.entryRelationship.nullFlavor | required | NullFlavor |
Supply.entryRelationship.typeCode | required | Fixed Value: SUBJ |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2Supply
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: