Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions

Resource Profile: MedicationSupplyOrder - Detailed Descriptions

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.17 resource profile.

1. Supply
Control1..1
2. Supply.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassSupply
Typecode
Requirements

SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7427).

Default ValueSPLY
Fixed ValueSPLY
3. Supply.moodCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @moodCode="INT" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7428).

Pattern ValueINT
4. Supply.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
5. Supply.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
6. Supply.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on Supply.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • ,
  • value @ extension
7. Supply.templateId:primary
SliceNameprimary
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-7429) such that it

8. Supply.templateId:primary.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
9. Supply.templateId:primary.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
10. Supply.templateId:primary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
11. Supply.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.17" (CONF:1098-10507).

Pattern Value2.16.840.1.113883.10.20.22.4.17
12. Supply.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32578).

Pattern Value2014-06-09
13. Supply.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain at least one [1..*] id (CONF:1098-7430).

14. Supply.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
15. Supply.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
16. Supply.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-7432).

17. Supply.statusCode.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
18. Supply.statusCode.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typestring
Requirements

This statusCode SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet ActStatus urn:oid:2.16.840.1.113883.1.11.15933 DYNAMIC (CONF:1098-32362).

19. Supply.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
20. Supply.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
21. Supply.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring
22. Supply.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring
23. Supply.statusCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
24. Supply.statusCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
25. Supply.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
26. Supply.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
27. Supply.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
28. Supply.effectiveTime
Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/SXCM-TS, http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
SlicingThis element introduces a set of slices on Supply.effectiveTime. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ high
29. Supply.effectiveTime:when
SliceNamewhen
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-15143) such that it

30. Supply.effectiveTime:when.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
31. Supply.effectiveTime:when.value
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

Control0..1
TypedateTime
32. Supply.effectiveTime:when.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

Control0..1
Typeboolean
33. Supply.effectiveTime:when.operator
Definition

A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.

Control0..1
Typecode
34. Supply.effectiveTime:when.low
Definition

This is the low limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
35. Supply.effectiveTime:when.high
Definition

This is the high limit of the interval.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

SHALL contain exactly one [1..1] high (CONF:1098-15144).

36. Supply.effectiveTime:when.width
Definition

The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
37. Supply.effectiveTime:when.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
38. Supply.priorityCode
Control0..*
BindingThe codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
39. Supply.repeatNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-INT
Requirements

SHOULD contain zero or one [0..1] repeatNumber (CONF:1098-7434).

40. Supply.independentInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
41. Supply.quantity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
Requirements

SHOULD contain zero or one [0..1] quantity (CONF:1098-7436).

42. Supply.expectedUseTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
43. Supply.product
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] product (CONF:1098-7439).

44. Supply.product.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetDirect
Typecode
Default ValuePRD
Fixed ValuePRD
45. Supply.product.manufacturedProduct
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(MedicationInformation, ImmunizationMedicationInformation)
Requirements

The product, if present, SHALL contain exactly one [1..1] Medication Information (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:1098-16093).

46. Supply.subject
Control0..1
TypeElement
47. Supply.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
Default ValueSBJ
Fixed ValueSBJ
48. Supply.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
49. Supply.subject.awarenessCode
Control0..1
BindingThe codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
50. Supply.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
51. Supply.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
52. Supply.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
53. Supply.author
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
Requirements

MAY contain zero or one [0..1] author (CONF:1098-7438).

54. Supply.informant
Control0..*
TypeElement
55. Supply.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
Default ValueINF
Fixed ValueINF
56. Supply.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
57. Supply.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
58. Supply.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
59. Supply.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
60. Supply.entryRelationship
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1098-7442).

InvariantsDefined on this element
sup-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
61. Supply.entryRelationship.typeCode
Control1..1
Typecode
Requirements

The entryRelationship, if present, SHALL contain exactly one [1..1] @typeCode="SUBJ" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7444).

Pattern ValueSUBJ
62. Supply.entryRelationship.inversionInd
Control1..1
Typeboolean
Requirements

The entryRelationship, if present, SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-7445).

Pattern Valuetrue
63. Supply.entryRelationship.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
64. Supply.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
65. Supply.entryRelationship.negationInd
Control0..1
Typeboolean
66. Supply.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
67. Supply.entryRelationship.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
68. Supply.entryRelationship.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
69. Supply.entryRelationship.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
70. Supply.entryRelationship.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
71. Supply.entryRelationship.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
72. Supply.entryRelationship.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
73. Supply.entryRelationship.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
74. Supply.entryRelationship.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
75. Supply.entryRelationship.act
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act(Instruction)
Requirements

The entryRelationship, if present, SHALL contain exactly one [1..1] Instruction (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-31391).

76. Supply.reference
Control0..*
TypeElement
77. Supply.reference.typeCode
Control1..1
Typecode
78. Supply.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
79. Supply.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
80. Supply.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
81. Supply.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
82. Supply.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
83. Supply.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition